Improving documentation on options

Also regenerated man page based on improvments
The previous messages were ambiguous
https://bugzilla.redhat.com/show_bug.cgi?id=888744
This commit is contained in:
Derek Higgins
2012-12-19 20:03:00 -05:00
parent 24df2a7bc6
commit ceb2af5697
13 changed files with 90 additions and 79 deletions

View File

@@ -27,8 +27,8 @@ def initConfig(controllerObject):
logging.debug("Adding Openstack swift configuration")
paramsList = [
{"CMD_OPTION" : "os-swift-proxy",
"USAGE" : "A comma seperated list of IP addresses on which to install the Swift proxy services",
"PROMPT" : "A comma seperated list of IP addresses on which to install the Swift proxy services",
"USAGE" : "The IP address on which to install the Swift proxy service",
"PROMPT" : "Enter the IP address of the Swift proxy service",
"OPTION_LIST" : [],
"VALIDATION_FUNC" : validate.validateSSH,
"DEFAULT_VALUE" : "127.0.0.1",
@@ -40,7 +40,7 @@ def initConfig(controllerObject):
"CONDITION" : False },
{"CMD_OPTION" : "os-swift-storage",
"USAGE" : "A comma seperated list of IP addresses on which to install the Swift Storage services, each entry should take the format <ipaddress>[/dev], for example 127.0.0.1/vdb will install /dev/vdb on 127.0.0.1 as a swift storage device, if /dev is ommited packstack will create a loopback device for a test setup",
"PROMPT" : "Hostname of the Swift Storage servers e.g. host/dev,host/dev",
"PROMPT" : "Enter the Swift Storage servers e.g. host/dev,host/dev",
"OPTION_LIST" : [],
"VALIDATION_FUNC" : validate.validateStringNotEmpty,
"DEFAULT_VALUE" : "127.0.0.1",
@@ -51,8 +51,8 @@ def initConfig(controllerObject):
"NEED_CONFIRM" : False,
"CONDITION" : False },
{"CMD_OPTION" : "os-swift-storage-zones",
"USAGE" : "Number of swift storage zones, this number MUST be no bigger then number of storage devices configered",
"PROMPT" : "Number of swift storage zones, this number MUST be no bigger then number of storage devices configered",
"USAGE" : "Number of swift storage zones, this number MUST be no bigger then number of storage devices configured",
"PROMPT" : "Enter the number of swift storage zones, MUST be no bigger then number of storage devices configured",
"OPTION_LIST" : [],
"VALIDATION_FUNC" : validate.validateInteger,
"DEFAULT_VALUE" : "1",
@@ -63,8 +63,8 @@ def initConfig(controllerObject):
"NEED_CONFIRM" : False,
"CONDITION" : False },
{"CMD_OPTION" : "os-swift-storage-replicas",
"USAGE" : "Number of swift storage replicas, this number MUST be no bigger then number of storage zones configered",
"PROMPT" : "Number of swift storage replicas, this number MUST be no bigger then number of storage zones configered",
"USAGE" : "Number of swift storage replicas, this number MUST be no bigger then number of storage zones configured",
"PROMPT" : "Enter the number of swift storage replicas, MUST be no bigger then number of storage zones configured",
"OPTION_LIST" : [],
"VALIDATION_FUNC" : validate.validateInteger,
"DEFAULT_VALUE" : "1",
@@ -76,7 +76,7 @@ def initConfig(controllerObject):
"CONDITION" : False },
{"CMD_OPTION" : "os-swift-storage-fstype",
"USAGE" : "FileSystem type for storage nodes",
"PROMPT" : "FileSystem type for storage nodes",
"PROMPT" : "Enter FileSystem type for storage nodes",
"OPTION_LIST" : ['xfs','ext4'],
"VALIDATION_FUNC" : validate.validateOptions,
"DEFAULT_VALUE" : "ext4",