LBaaS documentation is outdated , shows listeners instead of VIPs

[Diogo Monteiro]

The documentation for the LBaaS REST API endpoints listed on the office docs website does not match the REST API exposed by neutron.
Documentation URL: http://developer.openstack.org/api-ref-networking-v2.html#lbaas

In the API docs there is a reference to /listeners. However, neutron doesn't have an API for /listeners, it only has an API for /vips

Below is a curl command demonstrating the issue:
Listing VIPs: *WORKS
curl -i http://infracont.rnd.cloud:9696/v2.0/lb/vips -X GET -H "X-Auth-Token: 5c5b55bb54cc4c90971fc695ff44923d" -H "Content-Type: application/json" -H "Accept: application/json" -H "User-Agent: python-neutronclient"

Listing Listeners: *FAILS
curl -i http://infracont.rnd.cloud:9696/v2.0/lb/listeners -X GET -H "X-Auth-Token: 5c5b55bb54cc4c90971fc695ff44923d" -H "Content-Type: application/json" -H "Accept: application/json" -H "User-Agent: python-neutronclient"

Openstack icehouse deployment.
Running neutron version 2.3.4

[Eugene Nikanorov (enikanorov)]

It's because documentation changes for some reason landed before changes in neutron.
I think this should be targeted to proper project, as it needs to be fixed for documentation first.

[Diogo Monteiro (diogo-gmt)]

So are you saying the documentation has the latest information regarding LBaaS?
Instead of VIPs the new reference name would be LISTENERS?
Please clarify, thanks.

[Anne Gentle (annegentle)]

So, since you are on an Icehouse-configuration, you need Load Balancers v 1.0 API and that's currently missing, sorry.

You can see a WADL for it here:
http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/netconn-api/src/os-lbaas-ext.wadl#Listeners

[Anne Gentle (annegentle)]

Neutron bug triager, you can move to the openstack-api-site project.

[Diogo Monteiro (diogo-gmt)]

Anne, the link you placed in the comment above shows the documentation for loadbalancer listeners. However, for the LBaaS v1 I believe the documentation is being tracked here: https://wiki.openstack.org/wiki/Neutron/LBaaS/API_1.0

Also, when the new LBaaS version gets released on Junos, what will happen with the LBaaS API version 1? Will it be backwards compatible? Since I can see some API signatures being changed I assume it won't, right?

[Anne Gentle (annegentle)]

I believe it will not be backwards compatible, basing on what you're observing as well.

Also I don't know if lb v2 will be available in Juno.

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/119949
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=244c8fa25b1595588ebf477b64315bfd88e9543b
Submitter: Jenkins
Branch: master

commit 244c8fa25b1595588ebf477b64315bfd88e9543b
Author: Anne Gentle <email address hidden>
Date: Mon Sep 8 16:41:39 2014 -0500

    Provides LBaaS v1.0 extension info

     - removes experimental v2.0
     - Updates health_monitor JSON example

    Closes-bug:1214353
    Closes-bug:1361413
    Change-Id: Id5bd7417090ec65fb6f797870b909c75ba14d634

[Aditi Rajagopal (aditirajagopal)]

Marking the "neutron" section of this bug as invalid. The real fix needed to get into openstack-api-site