From 7f47c0006f9586f13514419f2fffb29233df9397 Mon Sep 17 00:00:00 2001 From: Atsushi SAKAI Date: Wed, 14 Oct 2015 18:50:11 +0900 Subject: [PATCH] Update Config Reference for manila Updates for Liberty Release Mainly same as ceilometer/nova changes Change-Id: I5aa547fdba384b08a422c001526bf7f4efa42ebb --- doc/common/tables/manila-glusterfs.xml | 8 ----- doc/common/tables/manila-logging.xml | 24 ++++++++------ doc/common/tables/manila-redis.xml | 22 +++++++------ doc/common/tables/manila-rpc.xml | 32 ++++++++++++++----- doc/common/tables/manila-zeromq.xml | 18 ++++++++--- .../manila.flagmappings | 18 +++++++---- 6 files changed, 76 insertions(+), 46 deletions(-) diff --git a/doc/common/tables/manila-glusterfs.xml b/doc/common/tables/manila-glusterfs.xml index 26f323c182..624feb2634 100644 --- a/doc/common/tables/manila-glusterfs.xml +++ b/doc/common/tables/manila-glusterfs.xml @@ -33,14 +33,6 @@ = $state_path/mnt (StrOpt) Base directory containing mount points for Gluster volumes. - - = None - (StrOpt) Path of Manila host's private SSH key file. - - - = None - (StrOpt) Remote GlusterFS server node's login password. This is not required if 'glusterfs_native_path_to_private_key' is configured. - = Gluster (StrOpt) Type of NFS server that mediate access to the Gluster volumes (Gluster or Ganesha). diff --git a/doc/common/tables/manila-logging.xml b/doc/common/tables/manila-logging.xml index 3212f57bbb..8f1168b993 100644 --- a/doc/common/tables/manila-logging.xml +++ b/doc/common/tables/manila-logging.xml @@ -23,7 +23,7 @@ = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN, taskflow=WARN - (ListOpt) List of logger=LEVEL pairs. + (ListOpt) List of logger=LEVEL pairs. This option is ignored if log_config_append is set. = False @@ -43,23 +43,23 @@ = None - (StrOpt) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation. + (StrOpt) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log_format). = %Y-%m-%d %H:%M:%S - (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s . + (StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. = None - (StrOpt) (Optional) The base directory used for relative --log-file paths. + (StrOpt) (Optional) The base directory used for relative --log-file paths. This option is ignored if log_config_append is set. = None - (StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. + (StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout. This option is ignored if log_config_append is set. = None - (StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. + (StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated. Please use logging_context_format_string and logging_default_format_string instead. This option is ignored if log_config_append is set. = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s @@ -83,24 +83,28 @@ = LOG_USER - (StrOpt) Syslog facility to receive log lines. + (StrOpt) Syslog facility to receive log lines. This option is ignored if log_config_append is set. = True - (BoolOpt) Log output to standard error. + (BoolOpt) Log output to standard error. This option is ignored if log_config_append is set. = False - (BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. + (BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set. = True - (BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in Kilo, and will be removed in Mitaka, along with this option. + (BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in Kilo, and will be removed in Mitaka, along with this option. This option is ignored if log_config_append is set. = True (BoolOpt) If set to false, will disable INFO logging level, making WARNING the default. + + = False + (BoolOpt) (Optional) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log-file option is specified and Linux platform is used. This option is ignored if log_config_append is set. + diff --git a/doc/common/tables/manila-redis.xml b/doc/common/tables/manila-redis.xml index 815dfba4d4..a129ba29fb 100644 --- a/doc/common/tables/manila-redis.xml +++ b/doc/common/tables/manila-redis.xml @@ -15,14 +15,10 @@ - [matchmaker_redis] + [DEFAULT] - = 127.0.0.1 - (StrOpt) Host to locate redis. - - - = None + = (StrOpt) Password for Redis server (optional). @@ -30,11 +26,19 @@ (IntOpt) Use this port to connect to redis host. - [matchmaker_ring] + [matchmaker_redis] - = /etc/oslo/matchmaker_ring.json - (StrOpt) Matchmaker ring file (JSON). + = 127.0.0.1 + (StrOpt) Host to locate redis. + + + = + (StrOpt) Password for Redis server (optional). + + + = 6379 + (IntOpt) Use this port to connect to redis host. diff --git a/doc/common/tables/manila-rpc.xml b/doc/common/tables/manila-rpc.xml index b751b02454..88ed725878 100644 --- a/doc/common/tables/manila-rpc.xml +++ b/doc/common/tables/manila-rpc.xml @@ -17,14 +17,6 @@ [DEFAULT] - - = 300 - (IntOpt) Heartbeat frequency. - - - = 600 - (IntOpt) Heartbeat time-to-live. - = rabbit (StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq. @@ -37,6 +29,10 @@ = 30 (IntOpt) Size of RPC connection pool. + + = 1 + (IntOpt) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired. + = 60 (IntOpt) Seconds to wait for a response from a call. @@ -79,6 +75,22 @@ = 0 (IntOpt) Timeout for inactive connections (in seconds) + + = + (StrOpt) Password for message broker authentication + + + = + (StrOpt) Path to directory that contains the SASL configuration + + + = + (StrOpt) Name of configuration file (without .conf suffix) + + + = + (StrOpt) Space separated list of acceptable SASL mechanisms + = exclusive (StrOpt) address prefix used when sending to a specific server @@ -103,6 +115,10 @@ = False (BoolOpt) Debug: dump AMQP frames to stdout + + = + (StrOpt) User name for message broker authentication + diff --git a/doc/common/tables/manila-zeromq.xml b/doc/common/tables/manila-zeromq.xml index 5c0134df6e..08abf4e473 100644 --- a/doc/common/tables/manila-zeromq.xml +++ b/doc/common/tables/manila-zeromq.xml @@ -17,10 +17,18 @@ [DEFAULT] + + = True + (BoolOpt) Use REQ/REP pattern for all methods CALL/CAST/FANOUT. + = * (StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address. + + = eventlet + (StrOpt) Type of concurrency used. Either "native" or "eventlet" + = 1 (IntOpt) Number of ZeroMQ contexts, defaults to 1. @@ -34,17 +42,17 @@ (StrOpt) Directory for holding IPC sockets. - = local + = redis (StrOpt) MatchMaker driver. - - = 9501 - (IntOpt) ZeroMQ receiver listening port. - = None (IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. + + = True + (BoolOpt) Shows whether zmq-messaging uses broker or not. + diff --git a/tools/autogenerate-config-flagmappings/manila.flagmappings b/tools/autogenerate-config-flagmappings/manila.flagmappings index ab1281780c..28820e1918 100644 --- a/tools/autogenerate-config-flagmappings/manila.flagmappings +++ b/tools/autogenerate-config-flagmappings/manila.flagmappings @@ -55,8 +55,6 @@ glusterfs_ganesha_server_ip glusterfs glusterfs_ganesha_server_password glusterfs glusterfs_ganesha_server_username glusterfs glusterfs_mount_point_base glusterfs -glusterfs_native_path_to_private_key glusterfs -glusterfs_native_server_password glusterfs glusterfs_nfs_server_type glusterfs glusterfs_path_to_private_key glusterfs glusterfs_server_password glusterfs @@ -106,8 +104,6 @@ logging_default_format_string logging logging_exception_prefix logging manila_huawei_conf_file huawei manila_service_keypair_name share -matchmaker_heartbeat_freq rpc -matchmaker_heartbeat_ttl rpc max_age quota max_gigabytes storage max_header_line api @@ -164,12 +160,14 @@ osapi_share_listen api osapi_share_listen_port api osapi_share_workers api ovs_integration_bridge share +password redis path_to_private_key share path_to_public_key share periodic_fuzzy_delay common periodic_hooks_interval common periodic_interval common pool_weight_multiplier scheduler +port redis publish_errors logging quobyte_api_ca quobyte quobyte_api_password quobyte @@ -193,13 +191,15 @@ rootwrap_config common rpc_backend rpc rpc_cast_timeout rpc rpc_conn_pool_size rpc +rpc_poll_timeout rpc rpc_response_timeout rpc +rpc_zmq_all_req_rep zeromq rpc_zmq_bind_address zeromq +rpc_zmq_concurrency zeromq rpc_zmq_contexts zeromq rpc_zmq_host zeromq rpc_zmq_ipc_dir zeromq rpc_zmq_matchmaker zeromq -rpc_zmq_port zeromq rpc_zmq_topic_backlog zeromq scheduler_default_filters scheduler scheduler_default_weighers scheduler @@ -270,6 +270,7 @@ verbose logging volume_api_class api volume_name_template api volume_snapshot_name_template api +watch_log_file logging winrm_cert_key_pem_path winrm winrm_cert_pem_path winrm winrm_conn_timeout winrm @@ -292,6 +293,7 @@ zfssa_nas_vscan zfssa zfssa_pool zfssa zfssa_project zfssa zfssa_rest_timeout zfssa +zmq_use_broker zeromq cors/allow_credentials cors cors/allow_headers cors cors/allow_methods cors @@ -365,7 +367,6 @@ keystone_authtoken/token_cache_time auth_token matchmaker_redis/host redis matchmaker_redis/password redis matchmaker_redis/port redis -matchmaker_ring/ringfile redis oslo_concurrency/disable_process_locking rpc oslo_concurrency/lock_path rpc oslo_messaging_amqp/allow_insecure_clients rpc @@ -373,12 +374,17 @@ oslo_messaging_amqp/broadcast_prefix rpc oslo_messaging_amqp/container_name rpc oslo_messaging_amqp/group_request_prefix rpc oslo_messaging_amqp/idle_timeout rpc +oslo_messaging_amqp/password rpc +oslo_messaging_amqp/sasl_config_dir rpc +oslo_messaging_amqp/sasl_config_name rpc +oslo_messaging_amqp/sasl_mechanisms rpc oslo_messaging_amqp/server_request_prefix rpc oslo_messaging_amqp/ssl_ca_file rpc oslo_messaging_amqp/ssl_cert_file rpc oslo_messaging_amqp/ssl_key_file rpc oslo_messaging_amqp/ssl_key_password rpc oslo_messaging_amqp/trace rpc +oslo_messaging_amqp/username rpc oslo_messaging_qpid/amqp_auto_delete qpid oslo_messaging_qpid/amqp_durable_queues qpid oslo_messaging_qpid/qpid_heartbeat qpid