Christian Berendt c3d8262ec5 Add doc8 test and improve rst syntax
This will test all rst files inside the doc directory for style issues with
doc8 (an opinionated style checker for rst styles of documentation).

This will fix all syntax issues identified by doc8 and will improve
the syntax.

Change-Id: Id1b9563e07e77e306aef5a0767c98c27f87c5c0e
2016-08-04 15:09:10 +02:00

5.1 KiB

Development Environment with Vagrant

This guide describes how to use Vagrant to assist in developing for Kolla.

Vagrant is a tool to assist in scripted creation of virtual machines. Vagrant takes care of setting up CentOS-based VMs for Kolla development, each with proper hardware like memory amount and number of network interfaces.

Getting Started

The Vagrant script implements all-in-one or multi-node deployments. all-in-one is the default.

In the case of multi-node deployment, the Vagrant setup builds a cluster with the following nodes by default:

  • 3 control nodes
  • 1 compute node
  • 1 storage node (Note: ceph requires at least 3 storage nodes)
  • 1 network node
  • 1 operator node

The cluster node count can be changed by editing the Vagrantfile.

Kolla runs from the operator node to deploy OpenStack.

All nodes are connected with each other on the secondary NIC. The primary NIC is behind a NAT interface for connecting with the Internet. The third NIC is connected without IP configuration to a public bridge interface. This may be used for Neutron/Nova to connect to instances.

Start by downloading and installing the Vagrant package for the distro of choice. Various downloads can be found at the Vagrant downloads.

On Fedora 22 it is as easy as:

sudo dnf install vagrant ruby-devel libvirt-devel libvirt-python

On Ubuntu 14.04 it is as easy as:

sudo apt-get install vagrant ruby-dev ruby-libvirt python-libvirt libvirt-dev nfs-kernel-server


Many distros ship outdated versions of Vagrant by default. When in doubt, always install the latest from the downloads page above.

Next install the hostmanager plugin so all hosts are recorded in /etc/hosts (inside each vm):

vagrant plugin install vagrant-hostmanager

Vagrant supports a wide range of virtualization technologies. This documentation describes libvirt. To install vagrant-libvirt plugin:

vagrant plugin install --plugin-version ">= 0.0.31" vagrant-libvirt

Some Linux distributions offer vagrant-libvirt packages, but the version they provide tends to be too old to run Kolla. A version of >= 0.0.31 is required.

Setup NFS to permit file sharing between host and VMs. Contrary to the rsync method, NFS allows both way synchronization and offers much better performance than VirtualBox shared folders. On Fedora 22:

sudo systemctl start nfs-server
firewall-cmd --permanent --add-port=2049/udp
firewall-cmd --permanent --add-port=2049/tcp
firewall-cmd --permanent --add-port=111/udp
firewall-cmd --permanent --add-port=111/tcp
sudo systemctl restart firewalld

Ensure your system has libvirt and associated software installed and setup correctly. On Fedora 22:

sudo dnf install @virtualization
sudo systemctl start libvirtd
sudo systemctl enable libvirtd

Find a location in the system's home directory and checkout the Kolla repo:

git clone https://github.com/openstack/kolla.git

Developers can now tweak the Vagrantfile or bring up the default all-in-one CentOS 7-based environment:

cd kolla/dev/vagrant && vagrant up

The command vagrant status provides a quick overview of the VMs composing the environment.

Vagrant Up

Once Vagrant has completed deploying all nodes, the next step is to launch Kolla. First, connect with the operator node:

vagrant ssh operator

To speed things up, there is a local registry running on the operator. All nodes are configured so they can use this insecure repo to pull from, and use it as a mirror. Ansible may use this registry to pull images from.

All nodes have a local folder shared between the group and the hypervisor, and a folder shared between all nodes and the hypervisor. This mapping is lost after reboots, so make sure to use the command vagrant reload <node> when reboots are required. Having this shared folder provides a method to supply a different docker binary to the cluster. The shared folder is also used to store the docker-registry files, so they are save from destructive operations like vagrant destroy.

Building images

Once logged on the operator VM call the kolla-build utility:


kolla-build accept arguments as documented in image-building. It builds Docker images and pushes them to the local registry if the push option is enabled (in Vagrant this is the default behaviour).

Deploying OpenStack with Kolla

Deploy all-in-one with:

sudo kolla-ansible deploy

Deploy multinode with:

sudo kolla-ansible deploy -i /usr/share/kolla/ansible/inventory/multinode

Validate OpenStack is operational:

kolla-ansible post-deploy
source /etc/kolla/admin-openrc.sh
openstack user list

Or navigate to with a web browser.

Further Reading

All Vagrant documentation can be found at docs.vagrantup.com.