From b9e8f7e2547f3cd93a088e90694c20d25a22de29 Mon Sep 17 00:00:00 2001 From: Michael Johnson Date: Tue, 23 Apr 2019 17:22:26 -0700 Subject: [PATCH] Update some octavia documentation This patch improves the Octavia documentation in two ways: It patch clarifies the format for the enabled_provider_drivers configuration setting. It also adds a link to the Octavia release notes to the documentation home page. Change-Id: I3f0349f37a5683061de2beff689314469a7dc255 --- doc/source/index.rst | 2 ++ etc/octavia.conf | 7 ++++--- octavia/common/config.py | 11 ++++++----- 3 files changed, 12 insertions(+), 8 deletions(-) diff --git a/doc/source/index.rst b/doc/source/index.rst index 745e238f04..b05bd09f86 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -9,6 +9,8 @@ network load balancing to OpenStack. See :doc:`reference/introduction` for an overview of Octavia. +For information on what is new see the `Octavia Release Notes `_. + To align with the overall OpenStack documentation, the Octavia documentation is grouped into the following topic areas. diff --git a/etc/octavia.conf b/etc/octavia.conf index ea950d3b83..d080745ad1 100644 --- a/etc/octavia.conf +++ b/etc/octavia.conf @@ -44,9 +44,10 @@ # allow_ping_health_monitors = True # Dictionary of enabled provider driver names and descriptions -# enabled_provider_drivers = {'amphora': 'The Octavia Amphora driver.', -# 'octavia': 'Deprecated alias of the Octavia ' -# 'Amphora driver.'} +# A comma separated list of dictionaries of the enabled provider driver names +# and descriptions. +# enabled_provider_drivers = amphora:The Octavia Amphora driver.,octavia: \ +# Deprecated alias of the Octavia Amphora driver. # Default provider driver # default_provider_driver = amphora diff --git a/octavia/common/config.py b/octavia/common/config.py index a0efa3223e..540b3396c2 100644 --- a/octavia/common/config.py +++ b/octavia/common/config.py @@ -80,12 +80,13 @@ api_opts = [ cfg.BoolOpt('allow_ping_health_monitors', default=True, help=_("Allow users to create PING type Health Monitors?")), cfg.DictOpt('enabled_provider_drivers', - help=_('List of enabled provider drivers and description ' - 'dictionaries. Must match the driver name in the ' + help=_('A comma separated list of dictionaries of the ' + 'enabled provider driver names and descriptions. ' + 'Must match the driver name in the ' 'octavia.api.drivers entrypoint. Example: ' - '{\'amphora\': \'The Octavia Amphora driver.\', ' - '\'octavia\': \'Deprecated alias of the Octavia ' - 'Amphora driver.\'}'), + 'amphora:The Octavia Amphora driver.,' + 'octavia:Deprecated alias of the Octavia ' + 'Amphora driver.'), default={'amphora': 'The Octavia Amphora driver.', 'octavia': 'Deprecated alias of the Octavia Amphora ' 'driver.'}),