Cloud Docs Home > F5 OpenStack Agent Index

F5® OpenStack Agent

Build Status Documentation Status

Overview

The F5® agent translates from ‘OpenStack’ to ‘F5®’. It uses the f5-sdk to translate OpenStack messaging calls – such as those from the Neutron RPC messaging queue – into iControl® REST calls to F5® technologies, such as BIG-IP®.

Installation

Quick Start

Install the f5-openstack-agent package for v 10.0.0:

$ sudo pip install git+https://github.com/F5Networks/f5-openstack-agent@v10.0.0

Tip

You can install packages from HEAD on a specific branches by adding @<branch_name> to the end of the install command instead of the release tag.

Example:

$ sudo pip install git+https://github.com/F5Networks/f5-openstack-agent@stable/newton

Debian Package

The f5-openstack-agent package can be installed using dpkg tools.

  1. Download and install the dependencies:
$ curl -L -O https://github.com/F5Networks/f5-common-python/releases/download/v2.3.3/python-f5-sdk_2.3.3-1_1404_all.deb
$ curl -L -O https://github.com/F5Networks/f5-icontrol-rest-python/releases/download/v1.3.0/python-f5-icontrol-rest_1.3.0-1_1404_all.deb
$ sudo dpkg –i python-f5-icontrol-rest_1.3.0-1_1404_all.deb
$ sudo dpkg –i python-f5-sdk_2.3.3-1_1404_all.deb
  1. Download and install the f5-openstack-agent:
$ curl -L -O https://github.com/F5Networks/f5-openstack-agent/releases/download/v10.0.0/python-f5-openstack-agent_10.0.0-1_1404_all.deb
$ sudo dpkg –i python-f5-openstack-agent_10.0.0-1_1404_all.deb

RPM Package

The f5-openstack-agent package can be installed using rpm tools.

  1. Download and install the dependencies:
$ curl -L -O https://github.com/F5Networks/f5-common-python/releases/download/v2.3.3/f5-sdk-2.3.3-1.el7.noarch.rpm
$ curl -L -O https://github.com/F5Networks/f5-icontrol-rest-python/releases/download/v1.3.0/f5-icontrol-rest-1.3.0-1.el7.noarch.rpm
$ sudo rpm -ivh f5-icontrol-rest-1.3.0-1.el7.noarch.rpm f5-sdk-2.3.3-1.el7.noarch.rpm
  1. Download and install the f5-openstack-agent:
$ curl -L -O https://github.com/F5Networks/f5-openstack-agent/releases/download/v10.0.0/f5-openstack-agent-10.0.0-1.el7.noarch.rpm
$ sudo rpm –ivh f5-openstack-agent-10.0.0-1.el7.noarch.rpm

Next Steps

Next, install the f5-openstack-lbaasv2-driver.

Need to Upgrade?

Please see the upgrade instructions.

For more information about using F5® technologies in OpenStack with Neutron LBaaSv2, please see the f5-openstack-lbaasv2-driver documentation.

Configuration and Usage

See the F5® OpenStack LBaaSv2 documentation.