diff options
author | Matt Stephenson <mattstep@mattstep.net> | 2012-03-06 15:57:52 -0800 |
---|---|---|
committer | Matt Stephenson <mattstep@mattstep.net> | 2012-03-06 20:46:57 -0800 |
commit | bacbfd2b7e58c8bfc493294ba619ce91ae3eaf1c (patch) | |
tree | 0447337b0b79e66ea635f160269b635f6678444f /nova/flags.py | |
parent | d954b11944a32b2465b62396855f249e6d09cdc6 (diff) | |
download | nova-bacbfd2b7e58c8bfc493294ba619ce91ae3eaf1c.tar.gz nova-bacbfd2b7e58c8bfc493294ba619ce91ae3eaf1c.tar.xz nova-bacbfd2b7e58c8bfc493294ba619ce91ae3eaf1c.zip |
Minor clarifications for the help strings in nova config options
Change-Id: I10e7277b2d9b7a905b83192f8db47f425c5ae11a
Diffstat (limited to 'nova/flags.py')
-rw-r--r-- | nova/flags.py | 129 |
1 files changed, 70 insertions, 59 deletions
diff --git a/nova/flags.py b/nova/flags.py index ed82fca30..ece5361c6 100644 --- a/nova/flags.py +++ b/nova/flags.py @@ -81,22 +81,24 @@ def _get_my_ip(): log_opts = [ cfg.StrOpt('logdir', default=None, - help='output to a per-service log file in named directory'), + help='Log output to a per-service log file in named directory'), cfg.StrOpt('logfile', default=None, - help='output to named file'), + help='Log output to a named file'), cfg.BoolOpt('use_stderr', default=True, - help='log to standard error'), + help='Log output to standard error'), ] core_opts = [ cfg.StrOpt('connection_type', default=None, - help='libvirt, xenapi or fake'), + help='Virtualization api connection type : libvirt, xenapi, ' + 'or fake'), cfg.StrOpt('sql_connection', default='sqlite:///$state_path/$sqlite_db', - help='connection string for sql database'), + help='The SQLAlchemy connection string used to connect to the ' + 'database'), cfg.StrOpt('api_paste_config', default="api-paste.ini", help='File name for the paste.deploy config for nova-api'), @@ -105,16 +107,16 @@ core_opts = [ help="Top-level directory for maintaining nova's state"), cfg.StrOpt('lock_path', default=os.path.join(os.path.dirname(__file__), '../'), - help='Directory for lock files'), + help='Directory to use for lock files'), ] debug_opts = [ cfg.BoolOpt('fake_network', default=False, - help='should we use fake network devices and addresses'), + help='If passed, use fake network devices and addresses'), cfg.BoolOpt('fake_rabbit', default=False, - help='use a fake rabbit'), + help='If passed, use a fake RabbitMQ provider'), ] FLAGS.register_cli_opts(log_opts) @@ -124,7 +126,7 @@ FLAGS.register_cli_opts(debug_opts) global_opts = [ cfg.StrOpt('my_ip', default=_get_my_ip(), - help='host ip address'), + help='ip address of this host'), cfg.ListOpt('region_list', default=[], help='list of region=fqdn pairs separated by commas'), @@ -136,25 +138,28 @@ global_opts = [ help='AWS Access Key'), cfg.StrOpt('glance_host', default='$my_ip', - help='default glance host'), + help='default glance hostname or ip'), cfg.IntOpt('glance_port', default=9292, help='default glance port'), cfg.ListOpt('glance_api_servers', default=['$glance_host:$glance_port'], - help='glance api servers available to nova (host:port)'), + help='A list of the glance api servers available to nova ' + '([hostname|ip]:port)'), cfg.IntOpt('glance_num_retries', default=0, help='Number retries when downloading an image from glance'), cfg.IntOpt('s3_port', default=3333, - help='s3 port'), + help='port used when accessing the s3 api'), cfg.StrOpt('s3_host', default='$my_ip', - help='s3 host (for infrastructure)'), + help='hostname or ip for openstack to use when accessing ' + 'the s3 api'), cfg.StrOpt('s3_dmz', default='$my_ip', - help='s3 dmz ip (for instances)'), + help='hostname or ip for the instances to use when accessing ' + 'the s3 api'), cfg.StrOpt('cert_topic', default='cert', help='the topic cert nodes listen on'), @@ -178,55 +183,58 @@ global_opts = [ help='the topic that nova-vsa service listens on'), cfg.StrOpt('rabbit_host', default='localhost', - help='rabbit host'), + help='the RabbitMQ host'), cfg.IntOpt('rabbit_port', default=5672, - help='rabbit port'), + help='the RabbitMQ port'), cfg.BoolOpt('rabbit_use_ssl', default=False, - help='connect over SSL'), + help='connect over SSL for RabbitMQ'), cfg.StrOpt('rabbit_userid', default='guest', - help='rabbit userid'), + help='the RabbitMQ userid'), cfg.StrOpt('rabbit_password', default='guest', - help='rabbit password'), + help='the RabbitMQ password'), cfg.StrOpt('rabbit_virtual_host', default='/', - help='rabbit virtual host'), + help='the RabbitMQ virtual host'), cfg.IntOpt('rabbit_retry_interval', default=1, - help='rabbit connection retry interval to start'), + help='how frequently to retry connecting with RabbitMQ'), cfg.IntOpt('rabbit_retry_backoff', default=2, - help='rabbit connection retry backoff in seconds'), + help='how long to backoff for between retries when connecting ' + 'to RabbitMQ'), cfg.IntOpt('rabbit_max_retries', default=0, - help='maximum rabbit connection attempts (0=try forever)'), + help='maximum retries with trying to connect to RabbitMQ ' + '(the default of 0 implies an infinite retry count)'), cfg.StrOpt('control_exchange', default='nova', - help='the main exchange to connect to'), + help='the main RabbitMQ exchange to connect to'), cfg.BoolOpt('rabbit_durable_queues', default=False, - help='use durable queues'), + help='use durable queues in RabbitMQ'), cfg.ListOpt('enabled_apis', default=['ec2', 'osapi_compute', 'osapi_volume', 'metadata'], - help='list of APIs to enable by default'), + help='a list of APIs to enable by default'), cfg.StrOpt('ec2_host', default='$my_ip', - help='ip of api server'), + help='the ip of the ec2 api server'), cfg.StrOpt('ec2_dmz_host', default='$my_ip', - help='internal ip of api server'), + help='the internal ip of the ec2 api server'), cfg.IntOpt('ec2_port', default=8773, - help='cloud controller port'), + help='the port of the ec2 api server'), cfg.StrOpt('ec2_scheme', default='http', - help='prefix for ec2'), + help='the protocol to use when connecting to the ec2 api ' + 'server (http, https)'), cfg.StrOpt('ec2_path', default='/services/Cloud', - help='suffix for ec2'), + help='the path prefix used to call the ec2 api server'), cfg.ListOpt('osapi_compute_ext_list', default=[], help='Specify list of extensions to load when using osapi_' @@ -249,10 +257,11 @@ global_opts = [ help='osapi volume extension to load'), cfg.StrOpt('osapi_scheme', default='http', - help='prefix for openstack'), + help='the protocol to use when connecting to the openstack api ' + 'server (http, https)'), cfg.StrOpt('osapi_path', default='/v1.1/', - help='suffix for openstack'), + help='the path prefix used to call the openstack api server'), cfg.StrOpt('osapi_compute_link_prefix', default=None, help='Base URL that will be presented to users in links ' @@ -263,16 +272,17 @@ global_opts = [ 'to glance resources'), cfg.IntOpt('osapi_max_limit', default=1000, - help='max number of items returned in a collection response'), + help='the maximum number of items returned in a single ' + 'response from a collection resource'), cfg.StrOpt('metadata_host', default='$my_ip', - help='ip of metadata server'), + help='the ip for the metadata api server'), cfg.IntOpt('metadata_port', default=8775, - help='Metadata API port'), + help='the port for the metadata api port'), cfg.StrOpt('default_project', default='openstack', - help='default project for openstack'), + help='the default project to use for openstack'), cfg.StrOpt('default_image', default='ami-11111', help='default image to use, testing only'), @@ -285,7 +295,7 @@ global_opts = [ 'use a raw disk image instead'), cfg.StrOpt('vpn_image_id', default='0', - help='image id for cloudpipe vpn server'), + help='image id used when starting up a cloudpipe vpn server'), cfg.StrOpt('vpn_key_suffix', default='-vpn', help='Suffix to add to project name for vpn key and secgroups'), @@ -294,52 +304,53 @@ global_opts = [ help='Seconds for auth tokens to linger'), cfg.StrOpt('logfile_mode', default='0644', - help='Default file mode of the logs.'), + help='Default file mode used when creating log files'), cfg.StrOpt('sqlite_db', default='nova.sqlite', - help='file name for sqlite'), + help='the filename to use with sqlite'), cfg.BoolOpt('sqlite_synchronous', default=True, - help='Synchronous mode for sqlite'), + help='If passed, use synchronous mode for sqlite'), cfg.IntOpt('sql_idle_timeout', default=3600, - help='timeout for idle sql database connections'), + help='timeout before idle sql connections are reaped'), cfg.IntOpt('sql_max_retries', default=12, - help='sql connection attempts'), + help='maximum number of retries for connecting to the sql ' + 'database'), cfg.IntOpt('sql_retry_interval', default=10, - help='sql connection retry interval'), + help='interval between retries of opening a sql connection'), cfg.StrOpt('compute_manager', default='nova.compute.manager.ComputeManager', - help='Manager for compute'), + help='full class name for the Manager for compute'), cfg.StrOpt('console_manager', default='nova.console.manager.ConsoleProxyManager', - help='Manager for console proxy'), + help='full class name for the Manager for console proxy'), cfg.StrOpt('cert_manager', default='nova.cert.manager.CertManager', - help='Manager for cert'), + help='full class name for the Manager for cert'), cfg.StrOpt('instance_dns_manager', default='nova.network.dns_driver.DNSDriver', - help='DNS Manager for instance IPs'), + help='full class name for the DNS Manager for instance IPs'), cfg.StrOpt('instance_dns_domain', default='', - help='DNS Zone for instance IPs'), + help='full class name for the DNS Zone for instance IPs'), cfg.StrOpt('floating_ip_dns_manager', default='nova.network.dns_driver.DNSDriver', - help='DNS Manager for floating IPs'), + help='full class name for the DNS Manager for floating IPs'), cfg.StrOpt('network_manager', default='nova.network.manager.VlanManager', - help='Manager for network'), + help='full class name for the Manager for network'), cfg.StrOpt('volume_manager', default='nova.volume.manager.VolumeManager', - help='Manager for volume'), + help='full class name for the Manager for volume'), cfg.StrOpt('scheduler_manager', default='nova.scheduler.manager.SchedulerManager', - help='Manager for scheduler'), + help='full class name for the Manager for scheduler'), cfg.StrOpt('vsa_manager', default='nova.vsa.manager.VsaManager', - help='Manager for vsa'), + help='full class name for the Manager for VSA'), cfg.StrOpt('vc_image_name', default='vc_image', help='the VC image ID (for a VC image that exists in Glance)'), @@ -431,7 +442,7 @@ global_opts = [ help='maximum time since last check-in for up service'), cfg.StrOpt('default_schedule_zone', default=None, - help='zone to use when user doesnt specify one'), + help='availability zone to use when user doesnt specify one'), cfg.ListOpt('isolated_images', default=[], help='Images to run on isolated host'), @@ -446,16 +457,16 @@ global_opts = [ help='Whether to use cow images'), cfg.StrOpt('compute_api_class', default='nova.compute.api.API', - help='The compute API class to use'), + help='The full class name of the compute API class to use'), cfg.StrOpt('network_api_class', default='nova.network.api.API', - help='The network API class to use'), + help='The full class name of the network API class to use'), cfg.StrOpt('volume_api_class', default='nova.volume.api.API', - help='The volume API class to use'), + help='The full class name of the volume API class to use'), cfg.StrOpt('security_group_handler', default='nova.network.quantum.sg.NullSecurityGroupHandler', - help='security group handler class'), + help='The full class name of the security group handler class'), cfg.StrOpt('default_access_ip_network_name', default=None, help='Name of network to use to set access ips for instances'), |