2012-03-21 11:25:06 -05:00
DevStack is a set of scripts and utilities to quickly deploy an OpenStack cloud.
2011-09-30 11:34:43 -07:00
# Goals
2012-02-04 02:13:23 -06:00
* To quickly build dev OpenStack environments in a clean Ubuntu or Fedora environment
2011-11-23 12:50:46 -08:00
* 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
2011-09-30 11:34:43 -07:00
* To make it easy to prototype cross-project features
2013-10-17 12:03:55 -05:00
* To provide an environment for the OpenStack CI testing on every commit to the projects
2011-09-12 16:15:11 -07:00
2013-10-17 12:03:55 -05:00
Read more at http://devstack.org.
2011-10-13 10:36:00 -07:00
2013-10-17 12:03:55 -05:00
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.
2013-08-04 19:53:19 -05:00
2011-11-23 12:50:46 -08:00
# Versions
2011-09-30 09:24:00 -07:00
2013-10-17 12:03:55 -05:00
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 grizzly OpenStack cloud:
2011-11-23 12:50:46 -08:00
2013-10-17 12:03:55 -05:00
git checkout stable/grizzly
2011-09-30 09:24:00 -07:00
./stack.sh
2013-10-17 12:03:55 -05:00
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::
2012-02-03 22:56:38 -06:00
2013-11-07 22:36:10 +11:00
GLANCE_REPO=git://git.openstack.org/openstack/glance.git
2012-03-21 11:25:06 -05:00
GLANCE_BRANCH=milestone-proposed
2012-02-03 22:56:38 -06:00
# Start A Dev Cloud
2013-10-17 12:03:55 -05:00
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):
2011-09-30 11:34:43 -07:00
2011-11-23 12:50:46 -08:00
./stack.sh
2011-09-30 11:34:43 -07:00
2011-11-23 12:50:46 -08:00
When the script finishes executing, you should be able to access OpenStack endpoints, like so:
2011-09-30 11:34:43 -07:00
2011-11-23 12:50:46 -08:00
* Horizon: http://myhost/
* Keystone: http://myhost:5000/v2.0/
2011-09-30 11:34:43 -07:00
2011-11-23 12:50:46 -08:00
We also provide an environment file that you can use to interact with your cloud via CLI:
2011-09-12 16:15:11 -07:00
2013-10-17 12:03:55 -05:00
# source openrc file to load your environment with OpenStack CLI creds
2011-11-23 12:50:46 -08:00
. openrc
# list instances
nova list
2012-03-08 00:33:54 -06:00
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
2011-11-23 12:50:46 -08:00
# list instances using ec2 api
euca-describe-instances
2011-09-12 19:29:56 -07:00
2013-10-04 12:35:24 -05:00
# 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...
2013-10-17 12:03:55 -05:00
``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.
This is a recent change (Oct 2013) from the previous behaviour of
automatically creating a ``stack` ` user. Automatically creating
user accounts is not the right response to running as root, so
2014-03-12 08:05:08 -04:00
that bit is now an explicit step using ``tools/create-stack-user.sh` `.
2013-10-17 12:03:55 -05:00
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).
2013-10-04 12:35:24 -05:00
2011-11-23 12:50:46 -08:00
# Customizing
2011-09-11 03:22:13 -07:00
2013-10-17 12:03:55 -05:00
You can override environment variables used in `stack.sh` by creating file
2013-11-12 12:09:40 +00:00
name `local.conf` with a ``localrc` ` section as shown below. It is likely
2013-10-17 12:03:55 -05:00
that you will need to do this to tweak your networking configuration should
you need to access your cloud from a different host.
[[local|localrc]]
VARIABLE=value
See the **Local Configuration** section below for more details.
2012-02-29 13:42:44 +00:00
2012-11-01 16:12:39 -04:00
# Database Backend
Multiple database backends are available. The available databases are defined in the lib/databases directory.
2013-10-17 12:03:55 -05:00
`mysql` is the default database, choose a different one by putting the
following in the `localrc` section:
2012-11-01 16:12:39 -04:00
2013-02-07 15:56:24 -06:00
disable_service mysql
enable_service postgresql
2012-11-01 16:12:39 -04:00
2013-02-07 15:56:24 -06:00
`mysql` is the default database.
2012-11-01 16:12:39 -04:00
2012-01-18 11:18:35 -05:00
# RPC Backend
Multiple RPC backends are available. Currently, this
includes RabbitMQ (default), Qpid, and ZeroMQ. Your backend of
2013-10-17 12:03:55 -05:00
choice may be selected via the `localrc` section.
2012-01-18 11:18:35 -05:00
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"
2013-06-21 18:18:02 +08:00
# Apache Frontend
2013-10-17 12:03:55 -05:00
Apache web server is enabled for wsgi services by setting
`APACHE_ENABLED_SERVICES` in your ``localrc` ` section. Remember to
enable these services at first as above.
2013-06-21 18:18:02 +08:00
APACHE_ENABLED_SERVICES+=keystone,swift
2012-02-29 13:42:44 +00:00
# Swift
2013-07-24 13:01:32 +10:00
Swift is disabled by default. When enabled, it is configured with
only one replica to avoid being IO/memory intensive on a small
vm. When running with only one replica the account, container and
object services will run directly in screen. The others services like
replicator, updaters or auditor runs in background.
2012-02-29 13:42:44 +00:00
2013-10-17 12:03:55 -05:00
If you would like to enable Swift you can add this to your `localrc` section:
2013-03-06 10:58:33 +01:00
2013-07-24 13:01:32 +10:00
enable_service s-proxy s-object s-container s-account
2012-02-29 13:42:44 +00:00
2013-07-24 13:01:32 +10:00
If you want a minimal Swift install with only Swift and Keystone you
2013-10-17 12:03:55 -05:00
can have this instead in your `localrc` section:
2012-03-15 20:43:26 +00:00
2012-07-05 17:10:03 -04:00
disable_all_services
2013-03-06 10:58:33 +01:00
enable_service key mysql s-proxy s-object s-container s-account
2013-07-24 13:01:32 +10:00
If you only want to do some testing of a real normal swift cluster
with multiple replicas you can do so by customizing the variable
2013-10-17 12:03:55 -05:00
`SWIFT_REPLICAS` in your `localrc` section (usually to 3).
2012-03-15 20:43:26 +00:00
2013-03-06 10:58:33 +01:00
# Swift S3
2012-03-15 20:43:26 +00:00
2013-10-17 12:03:55 -05:00
If you are enabling `swift3` in `ENABLED_SERVICES` DevStack will
2013-07-24 13:01:32 +10:00
install the swift3 middleware emulation. Swift will be configured to
act as a S3 endpoint for Keystone so effectively replacing the
`nova-objectstore` .
2012-03-15 20:43:26 +00:00
2013-07-24 13:01:32 +10:00
Only Swift proxy server is launched in the screen session all other
services are started in background and managed by `swift-init` tool.
2013-03-25 05:34:23 -07:00
2013-07-06 23:29:39 -04:00
# Neutron
2013-03-25 05:34:23 -07:00
Basic Setup
2013-07-24 13:01:32 +10:00
In order to enable Neutron a single node setup, you'll need the
2014-02-28 11:11:45 -06:00
following settings in your `local.conf` :
2013-03-25 05:34:23 -07:00
disable_service n-net
enable_service q-svc
enable_service q-agt
enable_service q-dhcp
enable_service q-l3
enable_service q-meta
2013-09-24 15:10:25 +02:00
enable_service q-metering
2013-10-17 12:03:55 -05:00
# Optional, to enable tempest configuration as part of DevStack
2013-03-25 05:34:23 -07:00
enable_service tempest
2013-04-08 15:38:03 -05:00
Then run `stack.sh` as normal.
2013-10-17 12:03:55 -05:00
DevStack supports setting specific Neutron configuration flags to the
service, Open vSwitch plugin and LinuxBridge plugin configuration files.
2014-02-28 11:11:45 -06:00
To make use of this feature, the settings can be added to ``local.conf` `.
The old ``Q_XXX_EXTRA_XXX_OPTS` ` variables are deprecated and will be removed
in the near future. The ``local.conf` ` headers for the replacements are:
2013-05-17 15:20:56 -05:00
2014-02-28 11:11:45 -06:00
* ``Q_SRV_EXTRA_OPTS` `:
[[post-config|/$Q_PLUGIN_CONF_FILE]]
[linuxbridge] # or [ovs]
* ``Q_AGENT_EXTRA_AGENT_OPTS` `:
[[post-config|/$Q_PLUGIN_CONF_FILE]]
[agent]
* ``Q_AGENT_EXTRA_SRV_OPTS` `:
[[post-config|/$Q_PLUGIN_CONF_FILE]]
[linuxbridge] # or [ovs]
* ``Q_SRV_EXTRA_DEFAULT_OPTS` `:
[[post-config|$NEUTRON_CONF]]
[DEFAULT]
Example extra config in `local.conf` :
2013-05-17 15:20:56 -05:00
2014-02-28 11:11:45 -06:00
[[post-config|/$Q_PLUGIN_CONF_FILE]]
[agent]
tunnel_type=vxlan
vxlan_udp_port=8472
2013-05-17 15:20:56 -05:00
2014-02-28 11:11:45 -06:00
[[post-config|$NEUTRON_CONF]]
[DEFAULT]
tenant_network_type=vxlan
2013-05-17 15:20:56 -05:00
2013-10-17 12:03:55 -05:00
DevStack also supports configuring the Neutron ML2 plugin. The ML2 plugin
2014-02-28 11:11:45 -06:00
can run with the OVS, LinuxBridge, or Hyper-V agents on compute hosts. This
is a simple way to configure the ml2 plugin:
2013-07-19 14:26:53 +00:00
# VLAN configuration
Q_PLUGIN=ml2
ENABLE_TENANT_VLANS=True
# GRE tunnel configuration
Q_PLUGIN=ml2
ENABLE_TENANT_TUNNELS=True
# VXLAN tunnel configuration
Q_PLUGIN=ml2
Q_ML2_TENANT_NETWORK_TYPE=vxlan
2013-10-17 12:03:55 -05:00
The above will default in DevStack to using the OVS on each compute host.
To change this, set the `Q_AGENT` variable to the agent you want to run
(e.g. linuxbridge).
2013-07-19 14:26:53 +00:00
Variable Name Notes
-------------------------------------------------------------------------------------
Q_AGENT This specifies which agent to run with the ML2 Plugin (either `openvswitch` or `linuxbridge` ).
Q_ML2_PLUGIN_MECHANISM_DRIVERS The ML2 MechanismDrivers to load. The default is none. Note, ML2 will work with the OVS and LinuxBridge agents by default.
Q_ML2_PLUGIN_TYPE_DRIVERS The ML2 TypeDrivers to load. Defaults to all available TypeDrivers.
Q_ML2_PLUGIN_GRE_TYPE_OPTIONS GRE TypeDriver options. Defaults to none.
Q_ML2_PLUGIN_VXLAN_TYPE_OPTIONS VXLAN TypeDriver options. Defaults to none.
Q_ML2_PLUGIN_VLAN_TYPE_OPTIONS VLAN TypeDriver options. Defaults to none.
2013-08-01 10:44:09 +12:00
# Heat
Heat is disabled by default. To enable it you'll need the following settings
2013-10-17 12:03:55 -05:00
in your `localrc` section:
2013-08-01 10:44:09 +12:00
enable_service heat h-api h-api-cfn h-api-cw h-eng
Heat can also run in standalone mode, and be configured to orchestrate
on an external OpenStack cloud. To launch only Heat in standalone mode
2013-10-17 12:03:55 -05:00
you'll need the following settings in your `localrc` section:
2013-08-01 10:44:09 +12:00
disable_all_services
enable_service rabbit mysql heat h-api h-api-cfn h-api-cw h-eng
HEAT_STANDALONE=True
KEYSTONE_SERVICE_HOST=...
KEYSTONE_AUTH_HOST=...
2013-04-08 15:38:03 -05:00
# Tempest
2013-03-25 05:34:23 -07:00
If tempest has been successfully configured, a basic set of smoke tests can be run as follows:
$ cd /opt/stack/tempest
2013-08-02 05:53:58 +08:00
$ nosetests tempest/scenario/test_network_basic_ops.py
2013-03-25 05:34:23 -07:00
2013-10-17 12:03:55 -05:00
# DevStack on Xenserver
If you would like to use Xenserver as the hypervisor, please refer to the instructions in `./tools/xen/README.md` .
2013-10-15 09:42:43 -05:00
# Additional Projects
2013-10-17 12:03:55 -05:00
DevStack has a hook mechanism to call out to a dispatch script at specific
points in the execution of `stack.sh` , `unstack.sh` and `clean.sh` . This
allows upper-layer projects, especially those that the lower layer projects
have no dependency on, to be added to DevStack without modifying the core
scripts. Tempest is built this way as an example of how to structure the
dispatch script, see `extras.d/80-tempest.sh` . See `extras.d/README.md`
for more information.
2013-10-15 09:42:43 -05:00
2013-04-08 15:38:03 -05:00
# Multi-Node Setup
2013-03-25 05:34:23 -07:00
2013-07-06 23:29:39 -04:00
A more interesting setup involves running multiple compute nodes, with Neutron networks connecting VMs on different compute nodes.
2013-03-25 05:34:23 -07:00
You should run at least one "controller node", which should have a `stackrc` that includes at least:
disable_service n-net
enable_service q-svc
enable_service q-agt
enable_service q-dhcp
enable_service q-l3
enable_service q-meta
2013-07-06 23:29:39 -04:00
enable_service neutron
2013-03-25 05:34:23 -07:00
2013-10-17 12:03:55 -05:00
You likely want to change your `localrc` section to run a scheduler that
will balance VMs across hosts:
2013-03-25 05:34:23 -07:00
SCHEDULER=nova.scheduler.simple.SimpleScheduler
You can then run many compute nodes, each of which should have a `stackrc` which includes the following, with the IP address of the above controller node:
2013-07-06 23:29:39 -04:00
ENABLED_SERVICES=n-cpu,rabbit,g-api,neutron,q-agt
2013-03-25 05:34:23 -07:00
SERVICE_HOST=[IP of controller node]
MYSQL_HOST=$SERVICE_HOST
RABBIT_HOST=$SERVICE_HOST
Q_HOST=$SERVICE_HOST
2013-05-24 11:21:11 -04:00
MATCHMAKER_REDIS_HOST=$SERVICE_HOST
2013-03-11 23:55:49 +00:00
# Cells
Cells is a new scaling option with a full spec at http://wiki.openstack.org/blueprint-nova-compute-cells.
2013-10-17 12:03:55 -05:00
To setup a cells environment add the following to your `localrc` section:
2013-03-11 23:55:49 +00:00
enable_service n-cell
2013-07-24 03:56:13 -07:00
Be aware that there are some features currently missing in cells, one notable one being security groups. The exercises have been patched to disable functionality not supported by cells.
2013-09-13 15:05:51 -05:00
# Local Configuration
Historically DevStack has used ``localrc` ` to contain all local configuration and customizations. More and more of the configuration variables available for DevStack are passed-through to the individual project configuration files. The old mechanism for this required specific code for each file and did not scale well. This is handled now by a master local configuration file.
# local.conf
The new config file ``local.conf` ` is an extended-INI format that introduces a new meta-section header that provides some additional information such as a phase name and destination config filename:
2013-10-17 12:03:55 -05:00
[[ < phase > | < config-file-name > ]]
2013-09-13 15:05:51 -05:00
2013-10-17 12:03:55 -05:00
where ``<phase>`` is one of a set of phase names defined by ``stack.sh` `
and ``<config-file-name>` ` is the configuration filename. The filename is
eval'ed in the ``stack.sh` ` context so all environment variables are
available and may be used. Using the project config file variables in
the header is strongly suggested (see the ``NOVA_CONF` ` example below).
If the path of the config file does not exist it is skipped.
2013-09-13 15:05:51 -05:00
The defined phases are:
2013-10-17 12:03:55 -05:00
* **local** - extracts ``localrc`` from ``local.conf`` before ``stackrc` ` is sourced
* **post-config** - runs after the layer 2 services are configured and before they are started
* **extra** - runs after services are started and before any files in ``extra.d` ` are executed
2013-11-07 12:12:35 -08:00
* **post-extra** - runs after files in ``extra.d` ` are executed
2013-09-13 15:05:51 -05:00
The file is processed strictly in sequence; meta-sections may be specified more than once but if any settings are duplicated the last to appear in the file will be used.
2013-10-17 12:03:55 -05:00
[[post-config|$NOVA_CONF]]
[DEFAULT]
use_syslog = True
2013-09-13 15:05:51 -05:00
2013-10-17 12:03:55 -05:00
[osapi_v3]
enabled = False
2013-09-13 15:05:51 -05:00
2013-10-17 12:03:55 -05:00
A specific meta-section ``local|localrc` ` is used to provide a default
``localrc`` file (actually ``.localrc.auto` `). This allows all custom
settings for DevStack to be contained in a single file. If ``localrc` `
exists it will be used instead to preserve backward-compatibility.
2013-09-13 15:05:51 -05:00
2013-10-17 12:03:55 -05:00
[[local|localrc]]
FIXED_RANGE=10.254.1.0/24
ADMIN_PASSWORD=speciale
LOGFILE=$DEST/logs/stack.sh.log
2013-09-13 15:05:51 -05:00
2013-10-17 12:03:55 -05:00
Note that ``Q_PLUGIN_CONF_FILE` ` is unique in that it is assumed to *NOT*
start with a ``/` ` (slash) character. A slash will need to be added:
2013-09-13 15:05:51 -05:00
2013-10-17 12:03:55 -05:00
[[post-config|/$Q_PLUGIN_CONF_FILE]]