openstack/deb-sahara
Code Issues Proposed changes

Improve help strings

Browse Source 
Follow oslo.config style guide for help strings better:
* Capitalize start of strings
* End strings with "."
* Improve text and grammar
* Add missing spaces

Change-Id: I09d15bdf002c0f2847dc08628d11f8f5199e76bf
This commit is contained in:
Andreas Jaeger 2014-02-23 19:06:31 +01:00
parent 438c381d12
commit 2fb685d463
8 changed files with 85 additions and 84 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
etc/savanna/savanna.conf.sample
View File

@ -4,15 +4,15 @@
# Options defined in savanna.config
#
# Hostname or IP address that will be used to listen on
# Hostname or IP address that will be used to listen on.
# (string value)
#host=
# Port that will be used to listen on (integer value)
# Port that will be used to listen on. (integer value)
#port=8386
# Log request/response exchange details: environ, headers and
# bodies (boolean value)
# bodies. (boolean value)
#log_exchange=false
# Maximum length of job binary data in kilobytes that may be
@ -22,21 +22,21 @@
# If set to True, Savanna will use floating IPs to communicate
# with instances. To make sure that all instances have
# floating IPs assigned in Nova Network set
# "auto_assign_floating_ip=True" in nova.conf.If Neutron is
# used for networking, make sure thatall Node Groups have
# "floating_ip_pool" parameterdefined. (boolean value)
# "auto_assign_floating_ip=True" in nova.conf. If Neutron is
# used for networking, make sure that all Node Groups have
# "floating_ip_pool" parameter defined. (boolean value)
#use_floating_ips=true
# The suffix of the node's FQDN. In nova-network that is
# dhcp_domain config parameter (string value)
# The suffix of the node's FQDN. In nova-network that is the
# dhcp_domain config parameter. (string value)
#node_domain=novalocal
# Use Neutron Networking (False indicates the use of Nova
# networking) (boolean value)
# networking). (boolean value)
#use_neutron=false
# Use network namespaces for communication (only valid to use
# in conjunction with use_neutron=True) (boolean value)
# in conjunction with use_neutron=True). (boolean value)
#use_namespaces=false
@ -44,26 +44,26 @@
# Options defined in savanna.main
#
# Protocol used to access OpenStack Identity service (string
# Protocol used to access OpenStack Identity service. (string
# value)
#os_auth_protocol=http
# IP or hostname of machine on which OpenStack Identity
# service is located (string value)
# service is located. (string value)
#os_auth_host=127.0.0.1
# Port of OpenStack Identity service (string value)
# Port of OpenStack Identity service. (string value)
#os_auth_port=5000
# This OpenStack user is used to verify provided tokens. The
# user must have admin role in <os_admin_tenant_name> tenant
# user must have admin role in <os_admin_tenant_name> tenant.
# (string value)
#os_admin_username=admin
# Password of the admin user (string value)
# Password of the admin user. (string value)
#os_admin_password=nova
# Name of tenant where the user is admin (string value)
# Name of tenant where the user is admin. (string value)
#os_admin_tenant_name=admin
# An engine which will be used to provision infrastructure for
@ -79,7 +79,7 @@
# Options defined in savanna.db.base
#
# Driver to use for database access (string value)
# Driver to use for database access. (string value)
#db_driver=savanna.db
@ -235,7 +235,7 @@
#
# Postfix for storing jobs in hdfs. Will be added to
# /user/hadoop/ (string value)
# /user/hadoop/. (string value)
#job_workflow_postfix=
@ -243,16 +243,16 @@
# Options defined in savanna.service.periodic
#
# enable periodic tasks (boolean value)
# Enable periodic tasks. (boolean value)
#periodic_enable=true
# range of seconds to randomly delay when starting the
# Range in seconds to randomly delay when starting the
# periodic task scheduler to reduce stampeding. (Disable by
# setting to 0) (integer value)
# setting to 0). (integer value)
#periodic_fuzzy_delay=60
# Max interval size between periodic tasks execution inseconds
# (integer value)
# Max interval size between periodic tasks execution in
# seconds (integer value)
#periodic_interval_max=60
@ -316,7 +316,8 @@
# Options defined in savanna.conductor.api
#
# Perform savanna-conductor operations locally (boolean value)
# Perform savanna-conductor operations locally. (boolean
# value)
#use_local=true

2
savanna/conductor/api.py
View File

@ -25,7 +25,7 @@ from savanna.openstack.common import log as logging
conductor_opts = [
cfg.BoolOpt('use_local',
default=True,
help='Perform savanna-conductor operations locally'),
help='Perform savanna-conductor operations locally.'),
]
conductor_group = cfg.OptGroup(name='conductor',

18
savanna/config.py
View File

@ -21,12 +21,12 @@ from savanna import version
cli_opts = [
cfg.StrOpt('host', default='',
help='Hostname or IP address that will be used to listen on'),
help='Hostname or IP address that will be used to listen on.'),
cfg.IntOpt('port', default=8386,
help='Port that will be used to listen on'),
help='Port that will be used to listen on.'),
cfg.BoolOpt('log-exchange', default=False,
help='Log request/response exchange details: environ, '
'headers and bodies')
'headers and bodies.')
]
edp_opts = [
@ -42,22 +42,22 @@ networking_opts = [
help='If set to True, Savanna will use floating IPs to '
'communicate with instances. To make sure that all '
'instances have floating IPs assigned in Nova Network '
'set "auto_assign_floating_ip=True" in nova.conf.'
'If Neutron is used for networking, make sure that'
'all Node Groups have "floating_ip_pool" parameter'
'set "auto_assign_floating_ip=True" in nova.conf. '
'If Neutron is used for networking, make sure that '
'all Node Groups have "floating_ip_pool" parameter '
'defined.'),
cfg.StrOpt('node_domain',
default='novalocal',
help="The suffix of the node's FQDN. In nova-network that is "
"dhcp_domain config parameter"),
"the dhcp_domain config parameter."),
cfg.BoolOpt('use_neutron',
default=False,
help="Use Neutron Networking (False indicates the use of Nova "
"networking)"),
"networking)."),
cfg.BoolOpt('use_namespaces',
default=False,
help="Use network namespaces for communication (only valid to "
"use in conjunction with use_neutron=True)")
"use in conjunction with use_neutron=True).")
]

2
savanna/db/base.py
View File

@ -22,7 +22,7 @@ from savanna.openstack.common import importutils
db_driver_opt = cfg.StrOpt('db_driver',
default='savanna.db',
help='Driver to use for database access')
help='Driver to use for database access.')
CONF = cfg.CONF
CONF.register_opt(db_driver_opt)

12
savanna/main.py
View File

@ -47,25 +47,25 @@ patches.patch_minidom_writexml()
opts = [
cfg.StrOpt('os_auth_protocol',
default='http',
help='Protocol used to access OpenStack Identity service'),
help='Protocol used to access OpenStack Identity service.'),
cfg.StrOpt('os_auth_host',
default='127.0.0.1',
help='IP or hostname of machine on which OpenStack Identity '
'service is located'),
'service is located.'),
cfg.StrOpt('os_auth_port',
default='5000',
help='Port of OpenStack Identity service'),
help='Port of OpenStack Identity service.'),
cfg.StrOpt('os_admin_username',
default='admin',
help='This OpenStack user is used to verify provided tokens. '
'The user must have admin role in <os_admin_tenant_name> '
'tenant'),
'tenant.'),
cfg.StrOpt('os_admin_password',
default='nova',
help='Password of the admin user'),
help='Password of the admin user.'),
cfg.StrOpt('os_admin_tenant_name',
default='admin',
help='Name of tenant where the user is admin'),
help='Name of tenant where the user is admin.'),
cfg.StrOpt('infrastructure_engine',
default='savanna',
help='An engine which will be used to provision '

2
savanna/service/edp/job_manager.py
View File

@ -39,7 +39,7 @@ opts = [
cfg.StrOpt('job_workflow_postfix',
default='',
help='Postfix for storing jobs in hdfs. Will be '
'added to /user/hadoop/')
'added to /user/hadoop/.')
]
CONF = cfg.CONF

8
savanna/service/periodic.py
View File

@ -32,15 +32,15 @@ LOG = log.getLogger(__name__)
periodic_opts = [
cfg.BoolOpt('periodic_enable',
default=True,
help='enable periodic tasks'),
help='Enable periodic tasks.'),
cfg.IntOpt('periodic_fuzzy_delay',
default=60,
help='range of seconds to randomly delay when starting the'
help='Range in seconds to randomly delay when starting the'
' periodic task scheduler to reduce stampeding.'
' (Disable by setting to 0)'),
' (Disable by setting to 0).'),
cfg.IntOpt('periodic_interval_max',
default=60,
help='Max interval size between periodic tasks execution in'
help='Max interval size between periodic tasks execution in '
'seconds'),
]

76
savanna/tests/integration/configs/config.py
View File

@ -57,13 +57,13 @@ COMMON_CONFIG_OPTS = [
help='Port for Savanna.'),
cfg.StrOpt('SAVANNA_API_VERSION',
default='v1.1',
help='Api version for Savanna.'),
help='API version for Savanna.'),
cfg.StrOpt('FLAVOR_ID',
default=None,
help='OpenStack flavor ID for virtual machines. If you leave '
'default value of this parameter then flavor ID will be '
'created automatically, using nova client. Created flavor '
'will have the following parameters: '
'the default value of this parameter, then flavor ID will '
'be created automatically, using nova client. The created '
'flavor will have the following parameters: '
'name=i-test-flavor-<id>, ram=1024, vcpus=1, disk=10, '
'ephemeral=10. <id> is ID of 8 characters '
'(letters and/or digits) which is added to name of flavor '
@ -90,21 +90,21 @@ COMMON_CONFIG_OPTS = [
cfg.StrOpt('USER_KEYPAIR_ID',
default='savanna-i-test-key-pair',
help='OpenStack key pair ID of your SSH public key. Savanna '
'transfers this key to cluster nodes for access of users '
'transfers this key to cluster nodes for access by users '
'to virtual machines of cluster via SSH. You can export '
'your id_rsa.pub public key to OpenStack and specify its '
'key pair ID in configuration file of tests. If you '
'already have key pair in OpenStack then you just should '
'specify its key pair ID in configuration file of tests. '
'If you have no key pair in OpenStack or you do not want '
'to export (create) key pair then you just should specify '
'any key pair ID which you like (for example, '
'"king-kong") but you have necessarily to leave default '
'value of PATH_TO_SSH_KEY parameter. In this case key pair'
' will be created automatically. Also to key pair ID will '
'be added little ID (8 characters (letters and/or digits))'
' for its uniqueness. In the end of tests key pair will '
'be deleted.'),
'already have a key pair in OpenStack, then you just '
'should specify its key pair ID in configuration file of '
'tests. If you have no key pair in OpenStack or you do '
'not want to export (create) key pair then you just '
'should specify any key pair ID which you like (for '
'example, "king-kong") but you have necessarily to leave '
'default value of PATH_TO_SSH_KEY parameter. In this case '
'the key pair will be created automatically. Also to key '
'pair ID will be added little ID (8 characters (letters '
'and/or digits)) for its uniqueness. In the end of tests '
'key pair will be deleted.'),
cfg.StrOpt('PATH_TO_SSH_KEY',
default=None,
help='Path to id_rsa key which is used with tests for remote '
@ -119,22 +119,22 @@ COMMON_CONFIG_OPTS = [
help='Pool name for floating IPs. If Savanna uses Nova '
'management network and auto assignment of IPs was '
'enabled then you should leave default value of this '
'parameter. If auto assignment was not enabled then you '
'parameter. If auto assignment was not enabled, then you '
'should specify value (floating IP pool name) of this '
'parameter. If Savanna uses Neutron management network '
'parameter. If Savanna uses Neutron management network, '
'then you should always specify value (floating IP pool '
'name) of this parameter.'),
cfg.BoolOpt('NEUTRON_ENABLED',
default=False,
help='If Savanna uses Nova management network then you should '
'leave default value of this flag. If Savanna uses '
'Neutron management network then you should set this '
'flag to True and specify values of the following '
help='If Savanna uses Nova management network, then you '
'should leave default value of this flag. If Savanna '
'uses Neutron management network, then you should set '
'this flag to True and specify values of the following '
'parameters: FLOATING_IP_POOL and '
'INTERNAL_NEUTRON_NETWORK.'),
cfg.StrOpt('INTERNAL_NEUTRON_NETWORK',
default='private',
help='Name for internal Neutron network. '),
help='Name for internal Neutron network.'),
cfg.BoolOpt('RETAIN_CLUSTER_AFTER_TEST',
default=False,
help='If this flag is True, the cluster and related '
@ -161,13 +161,13 @@ VANILLA_CONFIG_OPTS = [
help='Name for image which is used for cluster creation. Also '
'you can specify image ID or tag of image instead of '
'image name. If you do not specify image related '
'parameters then image for cluster creation will be '
'parameters, then the image for cluster creation will be '
'chosen by tag "savanna_i_tests".'),
cfg.StrOpt('IMAGE_TAG',
default=None,
help='Tag for image which is used for cluster creation. Also '
'you can specify image ID or image name instead of tag of '
'image. If you do not specify image related parameters '
'image. If you do not specify image related parameters, '
'then image for cluster creation will be chosen by '
'tag "savanna_i_tests".'),
cfg.StrOpt('SSH_USERNAME',
@ -209,7 +209,7 @@ VANILLA_CONFIG_OPTS = [
'processes.'),
cfg.BoolOpt('SKIP_ALL_TESTS_FOR_PLUGIN',
default=False,
help='If this flag is True then all tests for Vanilla plugin '
help='If this flag is True, then all tests for Vanilla plugin '
'will be skipped.'),
cfg.BoolOpt('SKIP_CINDER_TEST', default=False),
cfg.BoolOpt('SKIP_CLUSTER_CONFIG_TEST', default=False),
@ -229,21 +229,21 @@ HDP_CONFIG_OPTS = [
default=None,
help='ID for image which is used for cluster creation. Also '
'you can specify image name or tag of image instead of '
'image ID. If you do not specify image related parameters '
'then image for cluster creation will be chosen by '
'tag "savanna_i_tests".'),
'image ID. If you do not specify image related '
'parameters, then image for cluster creation will be '
'chosen by tag "savanna_i_tests".'),
cfg.StrOpt('IMAGE_NAME',
default=None,
help='Name for image which is used for cluster creation. Also '
'you can specify image ID or tag of image instead of '
'image name. If you do not specify image related '
'parameters then image for cluster creation will be '
'parameters, then image for cluster creation will be '
'chosen by tag "savanna_i_tests".'),
cfg.StrOpt('IMAGE_TAG',
default=None,
help='Tag for image which is used for cluster creation. Also '
'you can specify image ID or image name instead of tag of '
'image. If you do not specify image related parameters '
'image. If you do not specify image related parameters, '
'then image for cluster creation will be chosen by '
'tag "savanna_i_tests".'),
cfg.StrOpt('SSH_USERNAME',
@ -285,7 +285,7 @@ HDP_CONFIG_OPTS = [
'processes.'),
cfg.BoolOpt('SKIP_ALL_TESTS_FOR_PLUGIN',
default=True,
help='If this flag is True then all tests for HDP plugin '
help='If this flag is True, then all tests for HDP plugin '
'will be skipped.'),
cfg.BoolOpt('SKIP_CINDER_TEST', default=False),
cfg.BoolOpt('SKIP_MAP_REDUCE_TEST', default=False),
@ -306,21 +306,21 @@ IDH_CONFIG_OPTS = [
default=None,
help='ID for image which is used for cluster creation. Also '
'you can specify image name or tag of image instead of '
'image ID. If you do not specify image related parameters '
'then image for cluster creation will be chosen by '
'tag "savanna_i_tests".'),
'image ID. If you do not specify image related '
'parameters, then image for cluster creation will be '
'chosen by tag "savanna_i_tests".'),
cfg.StrOpt('IMAGE_NAME',
default=None,
help='Name for image which is used for cluster creation. Also '
'you can specify image ID or tag of image instead of '
'image name. If you do not specify image related '
'parameters then image for cluster creation will be '
'parameters, then image for cluster creation will be '
'chosen by tag "savanna_i_tests".'),
cfg.StrOpt('IMAGE_TAG',
default=None,
help='Tag for image which is used for cluster creation. Also '
'you can specify image ID or image name instead of tag of '
'image. If you do not specify image related parameters '
'image. If you do not specify image related parameters, '
'then image for cluster creation will be chosen by '
'tag "savanna_i_tests".'),
cfg.StrOpt('SSH_USERNAME',
@ -379,7 +379,7 @@ IDH_CONFIG_OPTS = [
cfg.BoolOpt('SKIP_ALL_TESTS_FOR_PLUGIN',
default=False,
help='If this flag is True then all tests for IDH plugin '
help='If this flag is True, then all tests for IDH plugin '
'will be skipped.'),
cfg.BoolOpt('SKIP_MAP_REDUCE_TEST', default=False),
cfg.BoolOpt('SKIP_SWIFT_TEST', default=True),