Revision as of 01:46, 26 January 2018

OpenStack neutron-lbaas Deprecation FAQ

Why are we deprecating neutron-lbaas?

What are the replacement projects?

• neutron-lbaas is replaced by Octavia
• neutron-lbaas-dashboard is replaced by octavia-dashboard
• neutron client is replaced by python-octaviaclient

Neutron-lbaas vs. LBaaS v2 API vs. Octavia vs. Octavia v2 API

neutron-lbaas

Neutron-lbaas is a neutron extension that extends the neutron API to provide load balancing capabilities. It implements the LBaaS v2 API. Neutron-lbaas run inside the neutron API process and must be installed with the neutron API.

LBaaS v2 API

LBaaS v2 API is the second version of the Load Balancing as a Service (LBaaS) API. LBaaS v1 is End of Life (EoL) as of the Mitaka OpenStack release cycle and has been archived.

Both neutron-lbaas and octavia implement the LBaaS v2 API, however octavia is a superset of the LBaaS v2 API meaning it includes additional features.

Octavia

Octavia is an official OpenStack service project providing load balancing capabilities for OpenStack. It includes a standalone API endpoint advertised in Keystone as service-type "load-balancer". Octavia includes a reference load balancing driver, octavia, that provides load balancing by using "amphora" which are currently implemented as service VMs. Octavia implements the LBaaS v2 API, like neutron-lbaas, but also provides additional features. See the Octavia v2 API reference.

Octavia v2 API

The Octavia v2 API is a fully backward compatible superset of the LBaaS v2 API. It includes all of the capabilities of the LBaaS v2 API with additional features such as: listener statistics, batch member updates, load balancer failover, status fields for all objects, cascade delete, and many more.

See the Octavia v2 API reference for more information on the Octavia v2 API.

How do I migrate to Octavia

If your neutron-lbaas load balancers are using the Octavia driver all you need to do is upgrade Octavia to the Pike release of OpenStack or newer and enable the v2 API. Your load balancer details are already in the Octavia database and using the Octavia driver infrastructure. This means that your applications can simply update the endpoint being used for load balancing from the neutron API endpoint to the Octavia API endpoint.

The lbaasv2-proxy neutron service plugin is available to allow users to continue to access load balancing via the neutron API during your migration. Please see the section titled "What migration tools are available?" for more information.

What migration tools are available?

The lbaasv2-proxy neutron service plugin is available to allow users to continue to access load balancing via the neutron API during your migration. This proxy will forward all load balancing requests received via the neutron API to the Octavia API. This should be used as a temporary migration tool as it is included in the neutron-lbaas code base and deprecation.

The database schema for Octavia is very similar to the neutron-lbaas schema in the neutron database. A database migration tool will be made available to move existing load balancers from the neutron-lbaas database into the Octavia database.

How do I install Octavia

You may already have Octavia installed as part of your neutron-lbaas installation. Octavia has been the reference driver since the OpenStack Liiberty release. If this is the case you only need to upgrade to the Pike release of OpenStack or newer and enable the v2 API.

There are a number of ways to install Octavia:

• By hand using the installation documentation.
• Using OpenStack Ansible
• Using OpenStack Tripleo
• And using vendor distributions that include Octavia.

Does Octavia support RBAC?

Yes, Octavia has Role Based Access Control on the Octavia v2 API. Please see the Octavia Policies page in the Octavia documentation.

Does Octavia have a Horizon dashboard (Web GUI)?

Yes, the Octavia dashboard provides a greatly enhanced load balancing horizon dashboard.

What is the Command Line Interface (CLI) for Octavia

The python-octaviaclient project provides an OpenStack Client (OSC) plugin.

The OpenStack Client is a unified CLI client for all OpenStack projects. It replaces the, deprecated since Ocata, neutron CLI client.

A command mapping table is available as part of the python-octaviaclient documentation.

Detailed command documentation is available as part of the python-octaviaclient documentation.

Updated user Cookbooks are also available as part of the Octavia user documentation set.

Where do I get more information?

• The Octavia documentation.
• The best way to reach the LBaaS team is via IRC on the Freenode IRC network channel #openstack-lbaas
• Weekly Meeting: 20:00 UTC on Wednesdays in #openstack-lbaas on the Freenode IRC network.
• Sending email to the OpenStack developer mailing list: openstack-dev [at] lists [dot] openstack [dot] org. Please prefix subject with '[openstack-dev][Octavia]'