How to install OpenStack on your local machine using Devstack

Grzegorz Pawelski - November 27, 2017 - Devstack | how-to | openstack | training

On November 7, we did a mini-course on Top Sysadmin Tasks and How to Do Them with OpenStack, and we promised to give you instructions on how to install OpenStack on your own laptop. Here it is.

The purpose of this guide is to allow you to install and deploy OpenStack on your own laptops or cloud VMs and follow the webinar exercises at home. The guide is both hardware and OS agnostic and can be used with AMD or Intel and Windows, Mac, or Linux. Furthermore the installation below is completely isolated and self contained using Virtual Machines. The guide is provided as is and Mirantis inc. is not responsible for any issues that may occur as a result of following this guide.

Step 1.

Create a Linux VM locally on your computer (for example, using VirtualBox) or remotely in the cloud (for example on AWS).

The VM needs to satisfy the following conditions:

VM needs at least 4 GB of memory and access to the Internet, and it needs to be accessible (at least) on tcp ports 22 (or console) and 80 from your laptop.

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.

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.

Step 2.

Log into the VM using ssh or the console.

Step 3.

You’ll need to run Devstack as a non-root user with sudo enabled. You can quickly create a separate user called stack to run DevStack with:

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

Step 4.

Because this user, stack, 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

You should see output of:

stack ALL=(ALL) NOPASSWD: ALL

Step 5.

Now you need to switch over to use the user stack:

sudo su - stack

Step 6.

Download DevStack:

git clone https://github.com/openstack-dev/devstack.git -b stable/pike devstack/

You should see:

Cloning into 'devstack'...

Notes

The above command downloads OpenStack release Pike. You can also check the list of available releases. To download releases in EOL status (End Of Life) replace -b stable/pike

with, for example, -b liberty-eol (for Liberty).

Step 7.

Change to the devstack directory:

cd devstack/

Step 8:

Determine your IP address:

sudo ifconfig

You will see a response something like this:

enp0s3 Link encap:Ethernet  HWaddr 08:00:27:ea:97:9f  
       inet addr:10.0.2.15  Bcast:10.0.2.255  Mask:255.255.255.0
       inet6 addr: fe80::d715:6025:f469:6f7c/64 Scope:Link
       UP BROADCAST RUNNING MULTICAST  MTU:1500  Metric:1
       RX packets:1364291 errors:0 dropped:0 overruns:0 frame:0
       TX packets:406550 errors:0 dropped:0 overruns:0 carrier:0
       collisions:0 txqueuelen:1000
       RX bytes:1415725472 (1.4 GB)  TX bytes:27942474 (27.9 MB)

lo     Link encap:Local Loopback  
       inet addr:127.0.0.1  Mask:255.0.0.0
       inet6 addr: ::1/128 Scope:Host
       UP LOOPBACK RUNNING  MTU:65536  Metric:1
       RX packets:229208 errors:0 dropped:0 overruns:0 frame:0
       TX packets:229208 errors:0 dropped:0 overruns:0 carrier:0
       collisions:0 txqueuelen:1000
       RX bytes:89805124 (89.8 MB)  TX bytes:89805124 (89.8 MB)

You’re looking for the addr: value in an interface other than lo. For example, in this case, it’s 10.0.2.15. Make note of that for the next step. If you run your VM on the cloud, make sure to use the public IP of your VM in the link.

Step 9.

Create the local.conf file with 4 passwords and your host IP, which you determined in the last step:

cat >  local.conf <<EOF
[[local|localrc]]
ADMIN_PASSWORD=secret
DATABASE_PASSWORD=\$ADMIN_PASSWORD
RABBIT_PASSWORD=\$ADMIN_PASSWORD
SERVICE_PASSWORD=\$ADMIN_PASSWORD
HOST_IP=10.0.2.15
RECLONE=yes
EOF

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

Step 10.

Now install and run OpenStack:

./stack.sh

At the end of the process you should see output something like this:

This is your host IP address: 10.0.2.15
This is your host IPv6 address: ::1
Horizon is now available at http://10.0.2.15/dashboard
Keystone is serving at http://10.0.2.15/identity/
The default users are: admin and demo
The password: secret
DevStack Version: pike
OS Version: Ubuntu 16.04 xenial
stack.sh completed in 1221 seconds.

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.

Step 11.

Access your OpenStack by copy-pasting the link from the above output into your web browser:

http://<HOST_IP>/dashboard

Use the default users demo or admin and configured password from step 8 (secret).

You should see the following log-in window in your browser:

From here, you can do whatever you need to, either from the Horizon interface, or by downloading credentials to use the command line.

You can find out how to do some of the more common tasks by viewing the original webinar, or check out our OpenStack Training resources.

24 responses to “How to install OpenStack on your local machine using Devstack”

Hareesh Reddy says:

December 1, 2017 at 01:55

I was facing trouble while installing OpenStack. I got it done now. Thank a lot for the guide Grzegorz.

Hareesh

Reply
David Mishra says:

December 1, 2017 at 01:57

Didn’t knew we can install OpenStack using DevStack. Thanks for sharing. Very informative article.

David Mishra

Reply
zzfancy says:

December 20, 2017 at 18:17

fyi,
step 3-5 can be replaced by devstack tools/create-stack-user.sh

Reply
nany says:

January 6, 2018 at 11:34

hi
thank you very much for the guide,but i got this error during installation and i’m using ubuntu server 16.04 , please help me:

/home/stack/devstack/stackrs:749 exit_distro_not_supported
/home/stack/devstack/functions-common: 265:die
[ERROR] /home/stack/devstack/functions-common: 265 support for xenial is incomplete : no support for invalid hardware type-

Thank you

Reply
1. Sid says:
  
  March 29, 2018 at 08:14
  
  It may be you have 32 bit Ubuntu 16.4 try installing Ubuntu 64 bit
  
  Reply
rey says:

February 14, 2018 at 22:04

hey!
thank you for this installation guide,but i got this error during installation and i’m using ubuntu server 16.04 , please help me:

/opt/stack/devstack/.localrc.auto: line 8: EOF: command not found
++./stack.sh:main:760 err_trap
++./stack.sh:err_trap:556 local r=127
++./stack.sh:err_trap:557 set +o xtrace
stack.sh failed
Error on exit
./stack.sh: line 540: generate-subunit: command not found

Reply
Tweakbox says:

February 20, 2018 at 11:09

I have successfully installed OpenStack using DevStack. Thank you so much for the guide Grzegorz.

Reply
Piotr Jakubowski says:

March 20, 2018 at 11:23

Thank you very much. Your guide has made it very easy for me to install.

Reply
1. Nick Chase says:
  
  March 25, 2018 at 16:21
  
  Thanks!
  
  Reply
teddrs says:

May 3, 2018 at 07:41

Thank you a lot for sharing. I followed this procedure on Fedora 20 and below is the error

“File “/usr/lib/python2.7/site-packages/pkg_resources.py”, line 1220, in comparison
raise SyntaxError(repr(cop)+” operator not allowed in environment markers”)
SyntaxError: ‘<' operator not allowed in environment markers
error in setup command: Error parsing /opt/stack/cinder/setup.cfg: SyntaxError: '<' operator not allowed in environment markers"

What am i missing?

Reply
Vadim Ivanov says:

July 19, 2018 at 01:06

Try upgrading pip and setuptools. It helped for me.

#pip install –upgrade pip
#pip install –upgrade setuptools

Reply
Eddy Snell says:

July 20, 2018 at 20:25

Hello to you and thank you very much for your installation guide that I followed to the letter. However, I am struck by an error during the finalization of my installation.
My error code is as follows:
devstack @ Job for DCE. Service flawed because the control process exided with error code.
See “Systemct1 Status Devstack @ DCE. service ” and “Journalct1-XE ” for details.
Please help me find a solution for my problem. Thank you well, I stay tuned

Reply
Harshal Dalvi says:

August 13, 2018 at 00:11

I am getting this error. please help

Error on exit
World dumping… see /opt/stack/logs/worlddump-2018-08-13-070106.txt for details
df: ‘/run/user/1000/gvfs’: Permission denied

Reply
Arihant says:

September 14, 2018 at 02:21

https://github.com/etcd-io/etcd/releases/download/v3.1.7/etcd-v3.1.7-linux-ppc64le.tar.gz not found error.

Reply
1. Nick Chase says:
  
  September 16, 2018 at 21:12
  
  Thanks, we’ll get that updated!
  
  Reply
Grzegorz says:

September 17, 2018 at 13:53

The problem seems to affect computers with PPC arch.
There is no etcd 3.1.7 for PPC.

You can try several solutions:

1)
switch to some newer releases of OpenStack

or

2)
change etcd version to some newer version with PPC arch supported
somewere in local.conf:
ETCD_DOWNLOAD_URL=some_url
to
https://github.com/etcd-io/etcd/releases/download/v3.2.0-rc.1/etcd-v3.2.0-rc.1-linux-ppc64le.tar.gz
(from https://github.com/etcd-io/etcd/releases/tag/v3.2.0-rc.1)

or

3)
disable etcd in local.conf:
disable_service etcd3

but it might break other things 🙁

Reply
Hiten says:

September 27, 2018 at 11:01

Kindly include chown -R stack /opt/stack/.cache into installation list. As it’s giving permission error while installation

Reply
vacon says:

October 7, 2018 at 00:55

Hi,
thank you for this post,
can i add compute node to this setup (aio)

Reply
Harchich Omar says:

October 28, 2018 at 16:07

Hey, I need a help. I got this error while installing Openstack :
[
If you wish to run this script anyway run with FORCE=yes
/opt/stack/devstack/functions-common: line 232: /opt/stack/logs/error.log: No such file or directory
]
Please can anyone help me, thanks a lot

Reply
Adrian says:

May 30, 2019 at 07:12

What ubuntu version are you using?
Devstack is not tested in Ubuntu 18.04 so, if you try to install it in this version, you will get this error.

Reply
Richard says:

June 14, 2019 at 07:17

I am getting this error. please help.

CRITICAL keystone [-] Unhandled error: KeyError: ‘connection’
ERROR keystone Traceback (most recent call last):
ERROR keystone File “/usr/local/bin/keystone-manage”, line 10, in
ERROR keystone sys.exit(main())
ERROR keystone File “/opt/stack/keystone/keystone/cmd/manage.py”, line 45, in main
ERROR keystone cli.main(argv=sys.argv, config_files=config_files)
ERROR keystone File “/opt/stack/keystone/keystone/cmd/cli.py”, line 1331, in main
ERROR keystone CONF.command.cmd_class.main()
ERROR keystone File “/opt/stack/keystone/keystone/cmd/cli.py”, line 530, in main
ERROR keystone CONF.command.version)
ERROR keystone File “/opt/stack/keystone/keystone/common/sql/upgrades.py”, line 250, in offline_sync_database_to_version
ERROR keystone expand_schema()
ERROR keystone File “/opt/stack/keystone/keystone/common/sql/upgrades.py”, line 321, in expand_schema
ERROR keystone _sync_common_repo(version=None)
ERROR keystone File “/opt/stack/keystone/keystone/common/sql/upgrades.py”, line 166, in _sync_common_repo
ERROR keystone with sql.session_for_write() as session:
ERROR keystone File “/usr/lib/python2.7/contextlib.py”, line 17, in __enter__
ERROR keystone return self.gen.next()
ERROR keystone File “/usr/local/lib/python2.7/dist-packages/oslo_db/sqlalchemy/enginefacade.py”, line 1030, in _transaction_scope
ERROR keystone context=context) as resource:
ERROR keystone File “/usr/lib/python2.7/contextlib.py”, line 17, in __enter__
ERROR keystone return self.gen.next()
ERROR keystone File “/usr/local/lib/python2.7/dist-packages/oslo_db/sqlalchemy/enginefacade.py”, line 635, in _session
ERROR keystone bind=self.connection, mode=self.mode)
ERROR keystone File “/usr/local/lib/python2.7/dist-packages/oslo_db/sqlalchemy/enginefacade.py”, line 399, in _create_session
ERROR keystone self._start()
ERROR keystone File “/usr/local/lib/python2.7/dist-packages/oslo_db/sqlalchemy/enginefacade.py”, line 485, in _start
ERROR keystone url_args[‘connection’],
ERROR keystone KeyError: ‘connection’
ERROR keystone
+lib/keystone:init_keystone:1 exit_trap
+./stack.sh:exit_trap:521 local r=1
++./stack.sh:exit_trap:522 jobs -p
+./stack.sh:exit_trap:522 jobs=
+./stack.sh:exit_trap:525 [[ -n ” ]]
+./stack.sh:exit_trap:531 ‘[‘ -f /tmp/tmp.is3D6jBwEk ‘]’
+./stack.sh:exit_trap:532 rm /tmp/tmp.is3D6jBwEk
+./stack.sh:exit_trap:536 kill_spinner
+./stack.sh:kill_spinner:417 ‘[‘ ‘!’ -z ” ‘]’
+./stack.sh:exit_trap:538 [[ 1 -ne 0 ]]
+./stack.sh:exit_trap:539 echo ‘Error on exit’
Error on exit
+./stack.sh:exit_trap:541 type -p generate-subunit
+./stack.sh:exit_trap:542 generate-subunit 1560520948 161 fail
+./stack.sh:exit_trap:544 [[ -z /opt/stack/logs ]]
+./stack.sh:exit_trap:547 /opt/stack/devstack/tools/worlddump.py -d /opt/stack/logs
World dumping… see /opt/stack/logs/worlddump-2019-06-14-140509.txt for details
+./stack.sh:exit_trap:556 exit 1

Please help me ,Thanks a lot!

Reply
Jalal says:

June 18, 2019 at 09:30

When I try this command “sudo ifconfig”, it asks me for “stack” user password, but I didn’t setup a password in the previous step?

Thanks,
Jalal

Reply
jamesh says:

July 25, 2019 at 05:55

iam facing this kind of error idont no how to solve iam using ubuntu 16.04
CRITICAL keystone [-] Unhandled error: KeyError: ‘connection’
ERROR keystone Traceback (most recent call last):
ERROR keystone File “/usr/local/bin/keystone-manage”, line 10, in
ERROR keystone sys.exit(main())
ERROR keystone File “/opt/stack/keystone/keystone/cmd/manage.py”, line 45, in main
ERROR keystone cli.main(argv=sys.argv, config_files=config_files)
ERROR keystone File “/opt/stack/keystone/keystone/cmd/cli.py”, line 1331, in main
ERROR keystone CONF.command.cmd_class.main()
ERROR keystone File “/opt/stack/keystone/keystone/cmd/cli.py”, line 530, in main
ERROR keystone CONF.command.version)
ERROR keystone File “/opt/stack/keystone/keystone/common/sql/upgrades.py”, line 250, in offline_sync_database_to_version
ERROR keystone expand_schema()
ERROR keystone File “/opt/stack/keystone/keystone/common/sql/upgrades.py”, line 321, in expand_schema
ERROR keystone _sync_common_repo(version=None)
ERROR keystone File “/opt/stack/keystone/keystone/common/sql/upgrades.py”, line 166, in _sync_common_repo
ERROR keystone with sql.session_for_write() as session:
ERROR keystone File “/usr/lib/python2.7/contextlib.py”, line 17, in __enter__
ERROR keystone return self.gen.next()
ERROR keystone File “/usr/local/lib/python2.7/dist-packages/oslo_db/sqlalchemy/enginefacade.py”, line 1030, in _transaction_scope
ERROR keystone context=context) as resource:
ERROR keystone File “/usr/lib/python2.7/contextlib.py”, line 17, in __enter__
ERROR keystone return self.gen.next()
ERROR keystone File “/usr/local/lib/python2.7/dist-packages/oslo_db/sqlalchemy/enginefacade.py”, line 635, in _session
ERROR keystone bind=self.connection, mode=self.mode)
ERROR keystone File “/usr/local/lib/python2.7/dist-packages/oslo_db/sqlalchemy/enginefacade.py”, line 399, in _create_session
ERROR keystone self._start()
ERROR keystone File “/usr/local/lib/python2.7/dist-packages/oslo_db/sqlalchemy/enginefacade.py”, line 485, in _start
ERROR keystone url_args[‘connection’],
ERROR keystone KeyError: ‘connection’
ERROR keystone
+lib/keystone:init_keystone:1 exit_trap
+./stack.sh:exit_trap:521 local r=1
++./stack.sh:exit_trap:522 jobs -p
+./stack.sh:exit_trap:522 jobs=
+./stack.sh:exit_trap:525 [[ -n ” ]]
+./stack.sh:exit_trap:531 ‘[‘ -f /tmp/tmp.2NyY83Yxhv ‘]’
+./stack.sh:exit_trap:532 rm /tmp/tmp.2NyY83Yxhv
+./stack.sh:exit_trap:536 kill_spinner
+./stack.sh:kill_spinner:417 ‘[‘ ‘!’ -z ” ‘]’
+./stack.sh:exit_trap:538 [[ 1 -ne 0 ]]
+./stack.sh:exit_trap:539 echo ‘Error on exit’
Error on exit
+./stack.sh:exit_trap:541 type -p generate-subunit
+./stack.sh:exit_trap:542 generate-subunit 1564055596 3020 fail
+./stack.sh:exit_trap:544 [[ -z /opt/stack/logs ]]
+./stack.sh:exit_trap:547 /opt/stack/devstack/tools/worlddump.py -d /opt/stack/logs
World dumping… see /opt/stack/logs/worlddump-2019-07-25-124336.txt for details
+./stack.sh:exit_trap:556 exit 1

Reply
Paolo says:

November 18, 2019 at 04:59

Thank you for your clear guide.
I tried It with Ubuntu desktop 18.04 on a VM (virtualbox).
Just before launching ./stack.sh
1) pay attention that /opt/stack/.cache Is owned by stack:stack (as writted in another post)
2) as stack user:
sudo python -m pip uninstall pip && sudo apt install python-pip reinstall

Reply

The Mirantis Blog

How to install OpenStack on your local machine using Devstack

Featured Posts

Create and manage an OpenStack-based KaaS child cluster

What We Announced Today and Why it Matters

How to build an edge cloud part 1: Building a simple facial recognition system

24 responses to “How to install OpenStack on your local machine using Devstack”

Leave a Reply Cancel reply