Quick Start for development¶
This guide provides step by step instructions to deploy OpenStack using Kolla Ansible on bare metal servers or virtual machines. For deployment/evaluation we have the quickstart guide.
Host machine requirements¶
The host machine must satisfy the following minimum requirements:
2 network interfaces
8GB main memory
40GB disk space
See the support matrix for details of supported host Operating Systems. Kolla Ansible supports the default Python 3.x versions provided by the supported Operating Systems. For more information see tested runtimes.
Typically commands that use the system package manager in this section must be run with root privileges.
It is generally recommended to use a virtual environment to install Kolla Ansible and its dependencies, to avoid conflicts with the system site packages. Note that this is independent from the use of a virtual environment for remote execution, which is described in Virtual Environments.
For Debian or Ubuntu, update the package index.
sudo apt update
Install Python build dependencies:
For CentOS, RHEL or openEuler, run:
sudo dnf install python3-devel libffi-devel gcc openssl-devel python3-libselinux
For Debian or Ubuntu, run:
sudo apt install python3-dev libffi-dev gcc libssl-dev
Install dependencies for the virtual environment¶
Install the virtual environment dependencies.
For CentOS, RHEL or openEuler, you don’t need to do anything.
For Debian or Ubuntu, run:
sudo apt install python3-venv
Create a virtual environment and activate it:
python3 -m venv /path/to/venv source /path/to/venv/bin/activate
The virtual environment should be activated before running any commands that depend on packages installed in it.
Ensure the latest version of pip is installed:
pip install -U pip
Install Ansible. Kolla Ansible requires at least Ansible
4and supports up to
pip install 'ansible>=4,<6'
kolla-ansiblerepository from git.
git clone --branch master https://opendev.org/openstack/kolla-ansible
Install requirements of
pip install ./kolla-ansible
sudo mkdir -p /etc/kolla sudo chown $USER:$USER /etc/kolla
Copy the configuration files to
kolla-ansibleholds the configuration files (
cp -r kolla-ansible/etc/kolla/* /etc/kolla
Copy the inventory files to the current directory.
kolla-ansibleholds inventory files (
multinode) in the
cp kolla-ansible/ansible/inventory/* .
Install Ansible Galaxy requirements¶
Install Ansible Galaxy dependencies:
Prepare initial configuration¶
The next step is to prepare our inventory file. An inventory is an Ansible file where we specify hosts and the groups that they belong to. We can use this to define node roles and access credentials.
Kolla Ansible comes with
multinode example inventory
files. The difference between them is that the former is ready for deploying
single node OpenStack on localhost. In this Guide we will show the
Passwords used in our deployment are stored in
file. All passwords are blank in this file and have to be filled either
manually or by running random password generator:
cd kolla-ansible/tools ./generate_passwords.py
globals.yml is the main configuration file for Kolla Ansible and per
default stored in /etc/kolla/globals.yml.
There are a few options that are required to deploy Kolla Ansible:
User has to specify images that are going to be used for our deployment. In this guide Quay.io-provided, pre-built images are going to be used. To learn more about building mechanism, please refer Building Container Images.
Kolla provides choice of several Linux distributions in containers:
CentOS Stream (
For newcomers, we recommend to use Rocky Linux 9 or Ubuntu 22.04.
Kolla Ansible requires a few networking options to be set. We need to set network interfaces used by OpenStack.
First interface to set is “network_interface”. This is the default interface for multiple management-type networks.
Second interface required is dedicated for Neutron external (or public) networks, can be vlan or flat, depends on how the networks are created. This interface should be active without IP address. If not, instances won’t be able to access to the external networks.
To learn more about network configuration, refer Network overview.
Next we need to provide floating IP for management traffic. This IP will be managed by keepalived to provide high availability, and should be set to be not used address in management network that is connected to our
network_interface. If you use an existing OpenStack installation for your deployment, make sure the IP is allowed in the configuration of your VM.
Enable additional services
By default Kolla Ansible provides a bare compute kit, however it does provide support for a vast selection of additional services. To enable them, set
Multiple globals files
For a more granular control, enabling any option from the main
globals.ymlfile can now be done using multiple yml files. Simply, create a directory called
/etc/kolla/and place all the relevant
*.ymlfiles in there. The
kolla-ansiblescript will, automatically, add all of them as arguments to the
An example use case for this would be if an operator wants to enable cinder and all its options, at a later stage than the initial deployment, without tampering with the existing
globals.ymlfile. That can be achieved, using a separate
cinder.ymlfile, placed under the
/etc/kolla/globals.d/directory and adding all the relevant options in there.
It is recommended to use a virtual environment to execute tasks on the remote hosts. This is covered in Virtual Environments.
After configuration is set, we can proceed to the deployment phase. First we need to setup basic host-level dependencies, like docker.
Kolla Ansible provides a playbook that will install all required services in the correct versions.
The following assumes the use of the
all-in-one inventory. If using a
different inventory, such as
multinode, replace the
Bootstrap servers with kolla deploy dependencies:
cd kolla-ansible/tools ./kolla-ansible -i ../../all-in-one bootstrap-servers
Do pre-deployment checks for hosts:
kolla-ansible -i ../../all-in-one prechecks
Finally proceed to actual OpenStack deployment:
kolla-ansible -i ../../all-in-one deploy
When this playbook finishes, OpenStack should be up, running and functional! If error occurs during execution, refer to troubleshooting guide.
Install the OpenStack CLI client:
pip install python-openstackclient -c https://releases.openstack.org/constraints/upper/master
OpenStack requires a
clouds.yamlfile where credentials for the admin user are set. To generate this file:
cd kolla-ansible/tools ./kolla-ansible post-deploy
The file will be generated in /etc/kolla/clouds.yaml, you can use it by copying it to /etc/openstack or ~/.config/openstack or setting OS_CLIENT_CONFIG_FILE environment variable.
Depending on how you installed Kolla Ansible, there is a script that will create example networks, images, and so on.
You are free to use the following
init-runoncescript for demo purposes but note it does not have to be run in order to use your cloud. Depending on your customisations, it may not work, or it may conflict with the resources you want to create. You have been warned.