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
changes/75/655275/2
Michael Johnson 4 years ago
parent fd1a7e5084
commit b9e8f7e254
  1. 2
      doc/source/index.rst
  2. 7
      etc/octavia.conf
  3. 11
      octavia/common/config.py

@ -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 <https://docs.openstack.org/releasenotes/octavia/>`_.
To align with the overall OpenStack documentation, the Octavia documentation
is grouped into the following topic areas.

@ -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

@ -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.'}),

Loading…
Cancel
Save