From 45ab30407e6170eaf36b00e5f4e745d73044da0e Mon Sep 17 00:00:00 2001 From: Dharini Chandrasekar Date: Fri, 15 Jul 2016 16:25:04 +0000 Subject: [PATCH] Improving help text for RPC opt Adding improved help text for allowed_rpc_exception_modules opt. Change-Id: I4bf2257cef7d99110e67aefa58dad9055e4dfccb Partial-Bug: #1570946 --- glance/common/rpc.py | 23 +++++++++++++++++++---- 1 file changed, 19 insertions(+), 4 deletions(-) diff --git a/glance/common/rpc.py b/glance/common/rpc.py index 7d9d0606..26fdad6f 100644 --- a/glance/common/rpc.py +++ b/glance/common/rpc.py @@ -36,15 +36,30 @@ LOG = logging.getLogger(__name__) rpc_opts = [ - # NOTE(flaper87): Shamelessly copied - # from oslo rpc. cfg.ListOpt('allowed_rpc_exception_modules', default=['glance.common.exception', 'builtins', 'exceptions', ], - help='Modules of exceptions that are permitted to be recreated' - ' upon receiving exception data from an rpc call.'), + help=_(""" +List of allowed exception modules to handle RPC exceptions. + +Provide a comma separated list of modules whose exceptions are +permitted to be recreated upon receiving exception data via an RPC +call made to Glance. The default list includes +``glance.common.exception``, ``builtins``, and ``exceptions``. + +The RPC protocol permits interaction with Glance via calls across a +network or within the same system. Including a list of exception +namespaces with this option enables RPC to propagate the exceptions +back to the users. + +Possible values: + * A comma separated list of valid exception modules + +Related options: + * None +""")), ] CONF = cfg.CONF