Kolla Builder

This repository contains a set of Ansible playbooks that will spawn and configure VMs (currently supporting libvirt only) to deploy Kolla.

Prerequisites

Host Machine

Machine where you run Libvirt instances that will run Kolla Can be the same as Local Machine or a remote machine.

• Libvirt

  sudo apt install qemu qemu-kvm libvirt-dev

• LibXML for python Important: install as root

sudo pip install lxml

Local Machine

Your machine where you run Kolla-Builder ansible playbooks from.

• Virt-manager (optional)

  sudo apt install virt-manager

• Kolla image

• Ansible

  pip install ansible

• Kolla Ansible source code

  git clone https://opendev.org/openstack/kolla-ansible.git

• Copy SSH key from ssh/id_kolla to your ~/.ssh directory

  cp ssh/id_kolla ~/.ssh

• Python libraries:

pip install libvirt-python
pip install lxml

• Docker for ARA (optional) - for ARA recording Ansible docker needs to be installed and runnig

Configuration

• Edit the example user config and options are documented in config examples.

Usage

Building Environment

The builder script is used to manage nodes with ansible-playbook .

Deploying ARA records ansible server (optional)

To deploy ARA server and start recording host ansible plays with ARA, ensure flag ara_enable in user_config.yml is set to true and run:

./builder ara user/local-aio.yml

Nodes plays will be recorded to this server too. ARA UI will then be accessible on localhost/remote host on specified ara_server_port, 8000 by default.

Spawning Nodes

To spawn a node or nodes, run:

./builder spawn user/local-aio.yml

If you want to spawn the nodes on a remote server, use the -r option:

./builder -r spawn user/remote-multinode.yml

Note: Only run the spawn action once to create the nodes. You need to delete them before running again.

Preparing Nodes

Once the nodes are booted, prepare them by running:

./builder prepare user/local-aio.yml

If you need to update something on the nodes, run the prepare action again:

./builder prepare user/local-aio.yml

Accessing Nodes

• For aio deployment

ssh -F ssh_config openstack-aio
# or whatever you named your node

• For multinode deployment

ssh -F ssh_config openstack-deployment
# or whatever you named your deploy node

Configuring Reverse Proxy on Remote Nodes

If you are using the remote option and need to configure a reverse proxy, run:

./builder -r nginx user/remote-aio.yml

Deploy script

• You can try the deploy script which is already on the node

./deploy

• If that fails, investigate the issue. Sometimes you just have to run the script again. If it doesn't help, see the next section.

• Otherwise reffer to Quick start for development

Remote Setup

• You can use kolla-builder to spawn Kolla on a remote server/cloud instance
• Edit remote inventory and add your server

PUBLIC.IP.OF.REMOTE ansible_ssh_user=ubuntu ansible_become=True ansible_private_key_file=/path/to/your/ssh_key

• If you use a remote Openstack instance, you need:
  • Network setup that allows outside connection
  • SSH keypair
  • Floating IP
  • Security group rules allow:
    • Egress for all connections
    • Ingress for SSH(22)
    • Ingress for HTTP(80)/HTTPS(443) to access Horizon from local browser
    • Ingress for any additional port you reverse proxy to
  • All the prerequisites must be installed on the instance

Deletion

To delete all nodes, use the delete action:

./builder delete user/local-multinode.yml

or for remote libvirt host

./builder -r delete user/local-multinode.yml