Octavia configuration options were deleted but required

[Michael Johnson]

One of the neutron team members just noticed that somehow the Octavia configuration documentation got deleted from the docs.

This section:
http://docs.openstack.org/liberty/config-reference/content/networking-plugin-lbaas.html
Previously contained a section for the octavia.conf (the neutron-lbaas reference driver)

But it appears this patch deleted it all:
https://review.openstack.org/#/c/259889/

This is a critical issue as Octavia is the reference driver and needs to be documented. We also have Mitaka updates for this documentation that need to go in.

[Ihar Hrachyshka (ihar-hrachyshka)]

Added octavia for tracking purposes.

[Anne Gentle (annegentle)]

pandoc -f rst -t docbook -s ${FILEPATH} will convert a file from DocBook XML to RST

[Michael Johnson (johnsom)]

pandoc -f docbook -t rst -s octavia.xml
Seems to work, but looking at all of the other files they say "auto-generated" so I think this is not the right solution.

[Gauvain Pocentek (gpocentek)]

The options for the LBaaS octavia driver are documented here: http://docs.openstack.org/draft/config-reference/networking/networking_options_reference.html#load-balancer-as-a-service-configuration-options

I don't find any additional option to be added.

[Michael Johnson (johnsom)]

Please compare to the liberty documentation: http://docs.openstack.org/liberty/config-reference/content/networking-plugin-lbaas.html
Table 10.68 for example.

That said, we are in progress of moving our documentation into our own repos.

[Gauvain Pocentek (gpocentek)]

Table 10.68 seems to describe options for the octavia service itself. I don't understand why this should be documented in the neutron section.

Please correct me if I'm wrong: Octavia is a standalone service, and neutron-lbaas can be configured to consume it. So I think octavia should have its own documentation section (in your repos or in openstack-manuals, this doesn't really matter to me).

If it helps we can generate the configuration options table with our tools.

[Michael Johnson (johnsom)]

Octavia is (one of very few) neutron projects and is the reference driver for neutron-lbaas.

[Gauvain Pocentek (gpocentek)]

OK, it wasn't really clear to me how close to neutron the project is.

Another problem I'm facing is technical: the import of octavia.common.config fails in an environment where all the neutron options are imported (this is how our tools work).

Is it OK with you if I create a "standalone table" for all octavia options, and include it somewhere in the neutron config-ref? I'm not sure that my question is very clear so I'll setup a WIP review for you to check.

[Gauvain Pocentek (gpocentek)]

https://review.openstack.org/296638

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/296638
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=1b13f13e34c56e3b4a4e1383bad37115c975bb4a
Submitter: Jenkins
Branch: master

commit 1b13f13e34c56e3b4a4e1383bad37115c975bb4a
Author: Gauvain Pocentek <email address hidden>
Date: Wed Mar 23 18:33:24 2016 +0100

    [config-ref] Include Octavia options

    Change-Id: I3e30eb80ba381f50f9587daeccfc33c42efee797
    Partial-Bug: #1552797

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/329341

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/329341
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=2aec2e543ca8abb0a0f8bb2c26abe0e8701a255f
Submitter: Jenkins
Branch: master

commit 2aec2e543ca8abb0a0f8bb2c26abe0e8701a255f
Author: KATO Tomoyuki <email address hidden>
Date: Tue Jun 14 18:39:50 2016 +0900

    [config-ref] reorganize Networking XX-as-a-Service

    backport: mitaka

    Change-Id: I38ec4c1c7063b772ad2500106fc113a4aff2ab03
    Closes-Bug: 1552797

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: stable/mitaka
Review: https://review.openstack.org/330343

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/330343
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=7aec3d00e892a50598cc45c8ed9ecf19d43a6975
Submitter: Jenkins
Branch: stable/mitaka

commit 7aec3d00e892a50598cc45c8ed9ecf19d43a6975
Author: KATO Tomoyuki <email address hidden>
Date: Tue Jun 14 18:39:50 2016 +0900

    [config-ref] reorganize Networking XX-as-a-Service

    backport: mitaka

    Change-Id: I38ec4c1c7063b772ad2500106fc113a4aff2ab03
    Closes-Bug: 1552797
    (cherry picked from commit 2aec2e543ca8abb0a0f8bb2c26abe0e8701a255f)

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/openstack-manuals 15.0.0 release.