The F5 Driver for OpenStack LBaaS assigns LBaaS tasks from the Neutron RPC Messaging queue to the F5 Agent for OpenStack Neutron.
The F5 agent translates the Neutron LBaaS API calls to iControl REST API calls and configures the requested objects on the BIG-IP device(s) identified in the F5 Agent Configuration File.

When the F5 agent and F5 driver run on your OpenStack Neutron Controller, you can use the native OpenStack CLI commands to manage BIG-IP LTM objects. [1]
The table below shows the corresponding iControl endpoint and BIG-IP object for each neutronlbaas-*create command.

View the F5 Agent Configuration parameters for detailed explanations of the available options.
The settings you apply in the configuration file should reflect your existing network architecture and BIG-IP system configurations.

Before you can upgrade to/install a different version of f5-openstack-agent, you need to uninstall your current version.
Perform the steps below on every server running F5 agent.

Danger

If you use pipinstall--upgrade to upgrade the F5 LBaaSv2 agent, packages that other OpenStack components use might be negatively impacted.
F5 does not recommend using pipinstall--upgrade to upgrade the f5-openstack-agent package.

Copy the F5 agent configuration file to a different directory (for example, ~/f5-upgrade-temp).

Warning

Your configuration file (/etc/neutron/services/f5/f5-openstack-agent.ini gets overwritten when you install a new package.
If you don’t save a copy elsewhere, you will lose your config settings.

Follow the installation instructions to install a different version of the F5 agent.

Copy your configuration file back into /etc/neutron/services/f5.

Tip

It’s good practice to compare your saved copy of the configuration file with the new one created during installation.
Verify that the only differences between the two are those required for your deployment.
If new options appear in the config file, see supported features and configuration parameters for explanations and config instructions.