cyborg/doc/source/contributor/devstack_setup.rst

DevStack Quick Start

Create stack user (optional)

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://opendev.org/openstack/devstack

$ cd devstack

The devstack repo contains a script that installs OpenStack.

Create local.conf file

Create a local.conf file at the root of the devstack git repo.

Host settings

[[local|localrc]]
HOST_IP=YOUR_IP_CONFIG
SERVICE_HOST=$HOST_IP
DATABASE_TYPE=mysql
MYSQL_HOST=$HOST_IP
RABBIT_HOST=$HOST_IP

• Replace YOUR_IP_CONFIG with your host IP (e.g. 10.0.0.72 or localhost).

Password settings

# Passwords
DATABASE_PASSWORD=123
ADMIN_PASSWORD=123
MYSQL_PASSWORD=123
RABBIT_PASSWORD=123
SERVICE_PASSWORD=123
SERVICE_TOKEN=ADMIN

• Pre-set the passwords to prevent interactive prompts.

Enable services

#FIXED_RANGE=192.168.128.0/24
#IPV4_ADDRS_SAFE_TO_USE=192.168.128.0/24
#GIT_BASE=/opt/git
disable_service n-net
disable_service tempest
disable_service heat
enable_service q-svc
enable_service q-agt
enable_service q-dhcp
enable_service q-l3
enable_service q-meta
enable_service neutron
enable_service n-novnc
enable_plugin cyborg https://opendev.org/openstack/cyborg
NOVA_VNC_ENABLED=True
NOVNCPROXY_URL="http://$SERVICE_HOST:6080/vnc_auto.html"
VNCSERVER_LISTEN=0.0.0.0
VNCSERVER_PROXYCLIENT_ADDRESS=$SERVICE_HOST
RECLONE=False
#enable Logging
LOGFILE=/opt/stack/logs/stack.sh.log
VERBOSE=True
LOG_COLOR=True
LOGDIR=/opt/stack/logs

• Uncomment GIT_BASE configuration if you have a local git repo
• enable_plugin cyborg will execute cyborg/devstack/plugin.sh and start cyborg service
• The devstack logs will appear in $LOGDIR

Note

If you got version conflicts, please set PIP_UPGRADE to True in local.conf

Multi-Node Lab

If you want to setup an OpenStack with cyborg in a realistic test configuration with multiple physical servers. Please ref¹.

Cluster Controller

disable_service cyborg-agent

Compute Nodes

enable_service cyborg-agent
disable_service cyborg-api
disable_service cyborg-cond

• If you do not want to setup cyborg-agent on controller, you can disable it.
• You do not need to enable cyborg-api and cyborg-cond on compute nodes.

Testing with unmerged changes

To test with changes that have not been merged, the enable_plugin line can be modifed to specify the branch/reference to be cloned.

enable_plugin cyborg https://review.opendev.org/openstack/cyborg refs/changes/28/708728/1

the format is

enable_plugin <directory name> <git repo url> <change/revision>

Cell V2 Deployment

Compute node services must be mapped to a cell before they can be used. Cell V2 deployment, please ref².

Run DevStack

$ ./stack.sh

This will take a 30-40 minutes, largely depending on the speed of your internet connection. Many git trees and packages will be installed during this process.

It will speed up your installation if you have a local GIT_BASE.

Use OpenStack

Command line

You can source openrc YOUR_USER YOUR_USER (e.g. source openrc admin admin) in your shell, and then use the openstack command line tool to manage your devstack.

Horizon

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

References

---

1. Openstack Multi-Node Lab Setup↩︎

2. Openstack Cell V2 Deployment Guide↩︎