openstack/oslo.messaging
Code Issues Proposed changes

Flesh out transport_url help

Browse Source 
This is a complicated config opt and the single line help text
doesn't provide anywhere near enough detail for a user to properly
configure it.  This change adds the expected format from the
TransportURL docstring and leaves a link to the docs for that
class since the full details are probably too verbose to put in the
help text in their entirety.

Change-Id: I66122bf9c619d35bcb3caadfde9c0dcdb5cd9095
This commit is contained in:
Ben Nemec 2017-10-03 02:13:03 +00:00
parent a9d10d33cd
commit d925e112b5
1 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
oslo_messaging/transport.py
View File

@ -43,8 +43,16 @@ LOG = logging.getLogger(__name__)
_transport_opts = [ _transport_opts = [
cfg.StrOpt('transport_url', cfg.StrOpt('transport_url',
secret=True, secret=True,
help='A URL representing the messaging driver to use and its ' help='The network address and optional user credentials for '
'full configuration.'), 'connecting to the messaging backend, in URL format. The '
'expected format is:\n\n'
'driver://[user:pass@]host:port[,[userN:passN@]hostN:'
'portN]/virtual_host?query\n\n'
'Example: rabbit://rabbitmq:password@127.0.0.1:5672//\n\n'
'For full details on the fields in the URL see the '
'documentation of oslo_messaging.TransportURL at '
'https://docs.openstack.org/oslo.messaging/latest/'
'reference/transport.html'),
cfg.StrOpt('rpc_backend', cfg.StrOpt('rpc_backend',
deprecated_for_removal=True, deprecated_for_removal=True,
deprecated_reason="Replaced by [DEFAULT]/transport_url", deprecated_reason="Replaced by [DEFAULT]/transport_url",
@ -283,11 +291,11 @@ class TransportURL(object):
Transport URLs take the form:: Transport URLs take the form::
scheme://[user:pass@]host:port[,[userN:passN@]hostN:portN]/virtual_host?query driver://[user:pass@]host:port[,[userN:passN@]hostN:portN]/virtual_host?query
where: where:
scheme driver
Specifies the transport driver to use. Typically this is `rabbit` for the Specifies the transport driver to use. Typically this is `rabbit` for the
RabbitMQ broker. See the documentation for other available transport RabbitMQ broker. See the documentation for other available transport
drivers. drivers.