18/12/2017 OpenStack Docs: DevStack

DevStack
 (configuration.html)  (https://bugs.launchpad.net/devstack/+filebug?field.title=DevStack%20in%20DevStack&field.comment=%0A%0A%0AThis bug tracker is for
errors with the documentation, use the following as a template and remove or add fields as you see fit. Convert [ ] into [x] to check boxes:%0A%0A- [ ] This doc is inaccurate
in this way: ______%0A- [ ] This is a doc addition request.%0A- [ ] I have a fix to the document that I can paste below including example: input and output. %0A%0AIf you have
a troubleshooting or support issue, use the following resources:%0A%0A - Ask OpenStack: http://ask.openstack.org%0A - The mailing list: http://lists.openstack.org%0A - IRC:
'openstack' channel on Freenode%0A%0A-----------------------------------
%0ARelease:%200.0.1.dev8954%20on%20Thu%20Dec%2014%2017:54:59%202017,%20commit%2062af936%0ASHA:%2062af9362aac72b3849ec2f8b80619ba568979d55%0ASo
dev/devstack/tree/doc/source/index.rst%0AURL: https://docs.openstack.org/devstack/latest/&field.tags=)

UPDATED: THU DEC 14 17:54:59 2017, COMMIT 62AF936

DevStack is a series of extensible scripts used to quickly bring up a complete OpenStack environment based on the latest versions of everything from git master. It is
used interactively as a development environment and as the basis for much of the OpenStack project’s functional testing.

The source is available at https://git.openstack.org/cgit/openstack-dev/devstack (https://git.openstack.org/cgit/openstack-dev/devstack).

 Warning

DevStack will make substantial changes to your system during installation. Only run DevStack on servers or virtual machines that are dedicated to this purpose.

Quick Start¶
Install Linux¶
Start with a clean and minimal install of a Linux system. Devstack attempts to support Ubuntu 16.04/17.04, Fedora 24/25, CentOS/RHEL 7, as well as Debian and
OpenSUSE.

If you do not have a preference, Ubuntu 16.04 is the most tested, and will probably go the smoothest.

Add Stack User¶

Devstack should be run as a non-root user with sudo enabled (standard logins to cloud images such as “ubuntu” or “cloud-user” are usually fine).

You can quickly create a separate stack user to run DevStack with

$ sudo useradd -s /bin/bash -d /opt/stack -m stack

Since this user will be making many changes to your system, it should have sudo privileges:

$ echo "stack ALL=(ALL) NOPASSWD: ALL" | sudo tee /etc/sudoers.d/stack

$ sudo su - stack

Download DevStack¶
$ git clone https://git.openstack.org/openstack-dev/devstack
$ cd devstack

The devstack repo contains a script that installs OpenStack and templates for configuration files

Create a local.conf¶
Create a local.conf file with 4 passwords preset at the root of the devstack git repo.

[[local|localrc]]
ADMIN_PASSWORD=secret
DATABASE_PASSWORD=$ADMIN_PASSWORD
RABBIT_PASSWORD=$ADMIN_PASSWORD
SERVICE_PASSWORD=$ADMIN_PASSWORD

This is the minimum required config to get started with DevStack.

Start the install¶

./stack.sh

https://docs.openstack.org/devstack/latest/ 1/4
18/12/2017 OpenStack Docs: DevStack
This will take a 15 - 20 minutes, largely depending on the speed of your internet connection. Many git trees and packages will be installed during this process.

Profit!¶
You now have a working DevStack! Congrats!

Your devstack will have installed keystone , glance , nova , cinder , neutron , and horizon . Floating IPs will be available, guests have access to the external world.

You can access horizon to experience the web interface to OpenStack, and manage vms, networks, volumes, and images from there.

You can source openrc in your shell, and then use the openstack command line tool to manage your devstack.

You can cd /opt/stack/tempest and run tempest tests that have been configured to work with your devstack.

You can make code changes to OpenStack and validate them (development.html).

Going further¶
Learn more about our configuration system (configuration.html) to customize devstack for your needs. Including making adjustments to the default networking
(networking.html).

Read guides (guides.html) for specific setups people have (note: guides are point in time contributions, and may not always be kept up to date to the latest devstack).

Enable devstack plugins (plugins.html) to support additional services, features, and configuration not present in base devstack.

Get the big picture (overview.html) of what we are trying to do with devstack, and help us by contributing to the project (hacking.html).

Contents¶
Configuration (configuration.html)
local.conf (configuration.html#local-conf)
openrc (configuration.html#openrc)
Minimal Configuration (configuration.html#minimal-configuration)
Historical Notes (configuration.html#historical-notes)
Configuration Notes (configuration.html#configuration-notes)
Developing with Devstack (development.html)
Inspecting Services (development.html#inspecting-services)
Patching a Service (development.html#patching-a-service)
Testing a Patch Series (development.html#testing-a-patch-series)
Testing Changes to Libraries (development.html#testing-changes-to-libraries)
FAQ (faq.html)
General Questions (faq.html#general-questions)
Operation and Configuration (faq.html#operation-and-configuration)
Miscellaneous (faq.html#miscellaneous)
Guides (guides.html)
All-In-One Single VM (guides/single-vm.html)
All-In-One Single Machine (guides/single-machine.html)
All-In-One Single LXC Container (guides/lxc.html)
Multi-Node Lab (guides/multinode-lab.html)
Using DevStack with neutron Networking (guides/neutron.html)
Configure DevStack with KVM-based Nested Virtualization (guides/devstack-with-nested-kvm.html)
Nova and DevStack (guides/nova.html)
Configure Load-Balancer Version 2 (guides/devstack-with-lbaas-v2.html)
All-In-One Single VM (guides.html#all-in-one-single-vm)
All-In-One Single Machine (guides.html#all-in-one-single-machine)
All-In-One LXC Container (guides.html#all-in-one-lxc-container)
Multi-Node Lab (guides.html#multi-node-lab)
DevStack with Neutron Networking (guides.html#devstack-with-neutron-networking)
DevStack with KVM-based Nested Virtualization (guides.html#devstack-with-kvm-based-nested-virtualization)
Nova and devstack (guides.html#nova-and-devstack)
Contributing to DevStack (hacking.html)
General (hacking.html#general)
Repo Layout (hacking.html#repo-layout)
Scripts (hacking.html#scripts)
stackrc (hacking.html#stackrc)
Documentation (hacking.html#documentation)
Exercises (hacking.html#exercises)
Whitespace Rules (hacking.html#whitespace-rules)
Control Structure Rules (hacking.html#control-structure-rules)
Variables and Functions (hacking.html#variables-and-functions)
Review Criteria (hacking.html#review-criteria)
Making Changes, Testing, and CI (hacking.html#making-changes-testing-and-ci)
DevStack Networking (networking.html)
Defaults (networking.html#defaults)
Locally Accessible Guests (networking.html#locally-accessible-guests)
Private Network Addressing (networking.html#private-network-addressing)
Overview (overview.html)
Supported Components (overview.html#supported-components)
DevStack Plugin Registry (plugin-registry.html)
Plugins (plugins.html)
Prerequisites (plugins.html#prerequisites)
Plugin Interface (plugins.html#plugin-interface)
plugin.sh contract (plugins.html#plugin-sh-contract)
https://docs.openstack.org/devstack/latest/ 2/4
18/12/2017 OpenStack Docs: DevStack
Example plugin (plugins.html#example-plugin)
Plugin Execution Order (plugins.html#plugin-execution-order)
System Packages (plugins.html#system-packages)
Using Plugins in the OpenStack Gate (plugins.html#using-plugins-in-the-openstack-gate)
See Also (plugins.html#see-also)
Using Systemd in DevStack (systemd.html)
Why this instead of screen? (systemd.html#why-this-instead-of-screen)
Unit Structure (systemd.html#unit-structure)
Manipulating Units (systemd.html#manipulating-units)
Querying Logs (systemd.html#querying-logs)
Debugging (systemd.html#debugging)
Known Issues (systemd.html#known-issues)
Future Work (systemd.html#future-work)
References (systemd.html#references)

 (configuration.html)  (https://bugs.launchpad.net/devstack/+filebug?field.title=DevStack%20in%20DevStack&field.comment=%0A%0A%0AThis bug tracker is

for errors with the documentation, use the following as a template and remove or add fields as you see fit. Convert [ ] into [x] to check boxes:%0A%0A- [ ] This doc is
inaccurate in this way: ______%0A- [ ] This is a doc addition request.%0A- [ ] I have a fix to the document that I can paste below including example: input and output.
%0A%0AIf you have a troubleshooting or support issue, use the following resources:%0A%0A - Ask OpenStack: http://ask.openstack.org%0A - The mailing list:
http://lists.openstack.org%0A - IRC: 'openstack' channel on Freenode%0A%0A-----------------------------------
%0ARelease:%200.0.1.dev8954%20on%20Thu%20Dec%2014%2017:54:59%202017,%20commit%2062af936%0ASHA:%2062af9362aac72b3849ec2f8b80619ba568979d55%0A
dev/devstack/tree/doc/source/index.rst%0AURL: https://docs.openstack.org/devstack/latest/&field.tags=)

UPDATED: THU DEC 14 17:54:59 2017, COMMIT 62AF936

(https://creativecommons.org/licenses/by/3.0/)
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License (https://creativecommons.org/licenses/by/3.0/). See all OpenStack Legal
Documents (http://www.openstack.org/legal).

 FOUND AN ERROR? REPORT A BUG (HTTPS://BUGS.LAUNCHPAD.NET/DEVSTACK/+FILEBUG?FIELD.TITLE=DEVSTACK%20IN%20DEVSTACK&FIELD.COMMENT=%0A%0A%0ATHIS BUG TRACKER IS FOR ERRORS

WITH THE DOCUMENTATION, USE THE FOLLOWING AS A TEMPLATE AND REMOVE OR ADD FIELDS AS YOU SEE FIT. CONVERT [ ] INTO [X] TO CHECK BOXES:%0A%0A- [ ] THIS DOC IS INACCURATE IN THIS WAY:
______%0A- [ ] THIS IS A DOC ADDITION REQUEST.%0A- [ ] I HAVE A FIX TO THE DOCUMENT THAT I CAN PASTE BELOW INCLUDING EXAMPLE: INPUT AND OUTPUT. %0A%0AIF YOU HAVE A TROUBLESHOOTING OR
SUPPORT ISSUE, USE THE FOLLOWING RESOURCES:%0A%0A - ASK OPENSTACK: HTTP://ASK.OPENSTACK.ORG%0A - THE MAILING LIST: HTTP://LISTS.OPENSTACK.ORG%0A - IRC: 'OPENSTACK' CHANNEL ON
FREENODE%0A%0A-----------------------------------
%0ARELEASE:%200.0.1.DEV8954%20ON%20THU%20DEC%2014%2017:54:59%202017,%20COMMIT%2062AF936%0ASHA:%2062AF9362AAC72B3849EC2F8B80619BA568979D55%0ASOURCE:%20HTTPS://GIT.OPENSTACK
DEV/DEVSTACK/TREE/DOC/SOURCE/INDEX.RST%0AURL: HTTPS://DOCS.OPENSTACK.ORG/DEVSTACK/LATEST/&FIELD.TAGS=)

 QUESTIONS? (HTTP://ASK.OPENSTACK.ORG)

 OpenStack Documentation 

DevStack 0.0.1.dev8954

Configuration (configuration.html)
Developing with Devstack (development.html)
FAQ (faq.html)
Guides (guides.html)
Contributing to DevStack (hacking.html)
DevStack Networking (networking.html)
Overview (overview.html)
DevStack Plugin Registry (plugin-registry.html)
Plugins (plugins.html)
Using Systemd in DevStack (systemd.html)

Page Contents

Quick Start
Install Linux
Add Stack User
Download DevStack
Create a local.conf
Start the install
Profit!
Going further
Contents

https://docs.openstack.org/devstack/latest/ 3/4
18/12/2017 OpenStack Docs: DevStack

OpenStack
Projects (http://openstack.org/projects/)
OpenStack Security (http://openstack.org/projects/openstack-security/)
Common Questions (http://openstack.org/projects/openstack-faq/)
Blog (http://openstack.org/blog/)
News (http://openstack.org/news/)

Community
User Groups (http://openstack.org/community/)
Events (http://openstack.org/community/events/)
Jobs (http://openstack.org/community/jobs/)
Companies (http://openstack.org/foundation/companies/)
Contribute (http://docs.openstack.org/infra/manual/developers.html)

Documentation
OpenStack Manuals (http://docs.openstack.org)
Getting Started (http://openstack.org/software/start/)
API Documentation (http://developer.openstack.org)
Wiki (https://wiki.openstack.org)

Branding & Legal

Logos & Guidelines (http://openstack.org/brand/)
Trademark Policy (http://openstack.org/brand/openstack-trademark-policy/)
Privacy Policy (http://openstack.org/privacy/)
OpenStack CLA (https://wiki.openstack.org/wiki/How_To_Contribute#Contributor_License_Agreement)

Stay In Touch
(https://twitter.com/OpenStack)
(https://www.facebook.com/openstack)
(https://www.linkedin.com/company/openstack)
(https://www.youtube.com/user/OpenStackFoundation)

The OpenStack project is provided under the Apache 2.0 license (http://www.apache.org/licenses/LICENSE-2.0). Openstack.org is powered by Rackspace Cloud Computing (http://rackspace.com).

https://docs.openstack.org/devstack/latest/ 4/4