From: Lorin Hochstein <lorin@nimbisservices.com>
Date: Tue, 4 Jun 2013 13:42:00 +0000 (-0400)
Subject: Add extra details in BigSwitch config
X-Git-Url: https://review.fuel-infra.org/gitweb?a=commitdiff_plain;h=554e26bb6f776f0b1bdbb0207882c69be8ee52d7;p=openstack-build%2Fneutron-build.git

Add extra details in BigSwitch config

Add some details to some of the BigSwitch configuration options.

The doc team will soon be generating documentation for configuration
options by extracting it directly from the source code help strings,
which is one of the motivations for adding this detail.

Change-Id: I7c694212bee29ac78135a4436633a202a6bba4a2
---

diff --git a/quantum/plugins/bigswitch/plugin.py b/quantum/plugins/bigswitch/plugin.py
index 447725087..78bb92e39 100644
--- a/quantum/plugins/bigswitch/plugin.py
+++ b/quantum/plugins/bigswitch/plugin.py
@@ -76,12 +76,18 @@ LOG = logging.getLogger(__name__)
 
 restproxy_opts = [
     cfg.StrOpt('servers', default='localhost:8800',
-               help=_("A comma separated list of servers and port numbers "
-                      "to proxy request to.")),
+               help=_("A comma separated list of BigSwitch or Floodlight "
+                      "servers and port numbers. The plugin proxies the "
+                      "requests to the BigSwitch/Floodlight server, "
+                      "which performs the networking configuration. Note that "
+                      "only one server is needed per deployment, but you may "
+                      "wish to deploy multiple servers to support failover.")),
     cfg.StrOpt('server_auth', default='username:password', secret=True,
-               help=_("Server authentication")),
+               help=_("The username and password for authenticating against "
+                      " the BigSwitch or Floodlight controller.")),
     cfg.BoolOpt('server_ssl', default=False,
-                help=_("Use SSL to connect")),
+                help=_("If True, Use SSL when connecting to the BigSwitch or "
+                       "Floodlight controller.")),
     cfg.BoolOpt('sync_data', default=False,
                 help=_("Sync data on connect")),
     cfg.IntOpt('server_timeout', default=10,