openstack/openstack-manuals
Code Issues Proposed changes

update cinder flags and tables

Browse Source 
Change-Id: I028787290ed4f24c2bccab3a2d5565eade54f291
This commit is contained in:
Gauvain Pocentek 2014-03-11 18:46:14 +01:00
parent b6053a9333
commit b0814458e4
3 changed files with 58 additions and 87 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
doc/common/tables/cinder-common.xml
View File

@ -34,14 +34,6 @@
<td>default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN</td>
<td>(ListOpt) List of logger=LEVEL pairs</td>
</tr>
<tr>
<td>default_notification_level = INFO</td>
<td>(StrOpt) Default notification level for outgoing notifications</td>
</tr>
<tr>
<td>default_publisher_id = None</td>
<td>(StrOpt) Default publisher_id for outgoing notifications</td>
</tr>
<tr>
<td>default_volume_type = None</td>
<td>(StrOpt) default volume type to use</td>
@ -245,28 +237,6 @@
<td>use_tpool = False</td>
<td>(BoolOpt) Enable the experimental use of thread pooling for all DB API calls</td>
</tr>
<tr>
<th colspan="2">[matchmaker_redis]</th>
</tr>
<tr>
<td>host = 127.0.0.1</td>
<td>(StrOpt) Host to locate redis</td>
</tr>
<tr>
<td>password = None</td>
<td>(StrOpt) Password for Redis server. (optional)</td>
</tr>
<tr>
<td>port = 6379</td>
<td>(IntOpt) Use this port to connect to redis host.</td>
</tr>
<tr>
<th colspan="2">[rpc_notifier2]</th>
</tr>
<tr>
<td>topics = notifications</td>
<td>(ListOpt) AMQP topic(s) used for OpenStack notifications</td>
</tr>
</tbody>
</table>
</para>

101
doc/common/tables/cinder-rpc.xml
View File

@ -42,25 +42,29 @@
<td>fake_rabbit = False</td>
<td>(BoolOpt) If passed, use a fake RabbitMQ provider</td>
</tr>
<tr>
<td>kombu_reconnect_delay = 1.0</td>
<td>(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.</td>
</tr>
<tr>
<td>kombu_ssl_ca_certs = </td>
<td>(StrOpt) SSL certification authority file (valid only if SSL enabled)</td>
<td>(StrOpt) SSL certification authority file (valid only if SSL enabled).</td>
</tr>
<tr>
<td>kombu_ssl_certfile = </td>
<td>(StrOpt) SSL cert file (valid only if SSL enabled)</td>
<td>(StrOpt) SSL cert file (valid only if SSL enabled).</td>
</tr>
<tr>
<td>kombu_ssl_keyfile = </td>
<td>(StrOpt) SSL key file (valid only if SSL enabled)</td>
<td>(StrOpt) SSL key file (valid only if SSL enabled).</td>
</tr>
<tr>
<td>kombu_ssl_version = </td>
<td>(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may be available on some distributions</td>
<td>(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may be available on some distributions.</td>
</tr>
<tr>
<td>matchmaker_heartbeat_freq = 300</td>
<td>(IntOpt) Heartbeat frequency</td>
<td>(IntOpt) Heartbeat frequency.</td>
</tr>
<tr>
<td>matchmaker_heartbeat_ttl = 600</td>
@ -68,11 +72,19 @@
</tr>
<tr>
<td>notification_driver = []</td>
<td>(MultiStrOpt) Driver or drivers to handle sending notifications</td>
<td>(MultiStrOpt) Driver or drivers to handle sending notifications.</td>
</tr>
<tr>
<td>notification_topics = notifications</td>
<td>(ListOpt) AMQP topic used for OpenStack notifications</td>
<td>(ListOpt) AMQP topic used for OpenStack notifications.</td>
</tr>
<tr>
<td>password = None</td>
<td>(StrOpt) Password for Redis server (optional).</td>
</tr>
<tr>
<td>port = 6379</td>
<td>(IntOpt) Use this port to connect to redis host.</td>
</tr>
<tr>
<td>publish_errors = False</td>
@ -80,35 +92,35 @@
</tr>
<tr>
<td>qpid_heartbeat = 60</td>
<td>(IntOpt) Seconds between connection keepalive heartbeats</td>
<td>(IntOpt) Seconds between connection keepalive heartbeats.</td>
</tr>
<tr>
<td>qpid_hostname = oslo</td>
<td>(StrOpt) Qpid broker hostname</td>
<td>(StrOpt) Qpid broker hostname.</td>
</tr>
<tr>
<td>qpid_hosts = $qpid_hostname:$qpid_port</td>
<td>(ListOpt) Qpid HA cluster host:port pairs</td>
<td>(ListOpt) Qpid HA cluster host:port pairs.</td>
</tr>
<tr>
<td>qpid_password = </td>
<td>(StrOpt) Password for qpid connection</td>
<td>(StrOpt) Password for Qpid connection.</td>
</tr>
<tr>
<td>qpid_port = 5672</td>
<td>(IntOpt) Qpid broker port</td>
<td>(IntOpt) Qpid broker port.</td>
</tr>
<tr>
<td>qpid_protocol = tcp</td>
<td>(StrOpt) Transport to use, either 'tcp' or 'ssl'</td>
<td>(StrOpt) Transport to use, either 'tcp' or 'ssl'.</td>
</tr>
<tr>
<td>qpid_sasl_mechanisms = </td>
<td>(StrOpt) Space separated list of SASL mechanisms to use for auth</td>
<td>(StrOpt) Space separated list of SASL mechanisms to use for auth.</td>
</tr>
<tr>
<td>qpid_tcp_nodelay = True</td>
<td>(BoolOpt) Disable Nagle algorithm</td>
<td>(BoolOpt) Whether to disable the Nagle algorithm.</td>
</tr>
<tr>
<td>qpid_topology_version = 1</td>
@ -116,51 +128,55 @@
</tr>
<tr>
<td>qpid_username = </td>
<td>(StrOpt) Username for qpid connection</td>
<td>(StrOpt) Username for Qpid connection.</td>
</tr>
<tr>
<td>rabbit_ha_queues = False</td>
<td>(BoolOpt) use H/A queues in RabbitMQ (x-ha-policy: all).You need to wipe RabbitMQ database when changing this option.</td>
<td>(BoolOpt) Use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database.</td>
</tr>
<tr>
<td>rabbit_host = oslo</td>
<td>(StrOpt) The RabbitMQ broker address where a single node is used</td>
<td>(StrOpt) The RabbitMQ broker address where a single node is used.</td>
</tr>
<tr>
<td>rabbit_hosts = $rabbit_host:$rabbit_port</td>
<td>(ListOpt) RabbitMQ HA cluster host:port pairs</td>
<td>(ListOpt) RabbitMQ HA cluster host:port pairs.</td>
</tr>
<tr>
<td>rabbit_login_method = AMQPLAIN</td>
<td>(StrOpt) the RabbitMQ login method</td>
</tr>
<tr>
<td>rabbit_max_retries = 0</td>
<td>(IntOpt) maximum retries with trying to connect to RabbitMQ (the default of 0 implies an infinite retry count)</td>
<td>(IntOpt) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count).</td>
</tr>
<tr>
<td>rabbit_password = guest</td>
<td>(StrOpt) the RabbitMQ password</td>
<td>(StrOpt) The RabbitMQ password.</td>
</tr>
<tr>
<td>rabbit_port = 5672</td>
<td>(IntOpt) The RabbitMQ broker port where a single node is used</td>
<td>(IntOpt) The RabbitMQ broker port where a single node is used.</td>
</tr>
<tr>
<td>rabbit_retry_backoff = 2</td>
<td>(IntOpt) how long to backoff for between retries when connecting to RabbitMQ</td>
<td>(IntOpt) How long to backoff for between retries when connecting to RabbitMQ.</td>
</tr>
<tr>
<td>rabbit_retry_interval = 1</td>
<td>(IntOpt) how frequently to retry connecting with RabbitMQ</td>
<td>(IntOpt) How frequently to retry connecting with RabbitMQ.</td>
</tr>
<tr>
<td>rabbit_use_ssl = False</td>
<td>(BoolOpt) connect over SSL for RabbitMQ</td>
<td>(BoolOpt) Connect over SSL for RabbitMQ.</td>
</tr>
<tr>
<td>rabbit_userid = guest</td>
<td>(StrOpt) the RabbitMQ userid</td>
<td>(StrOpt) The RabbitMQ userid.</td>
</tr>
<tr>
<td>rabbit_virtual_host = /</td>
<td>(StrOpt) the RabbitMQ virtual host</td>
<td>(StrOpt) The RabbitMQ virtual host.</td>
</tr>
<tr>
<td>rpc_backend = cinder.openstack.common.rpc.impl_kombu</td>
@ -188,7 +204,7 @@
</tr>
<tr>
<td>rpc_zmq_contexts = 1</td>
<td>(IntOpt) Number of ZeroMQ contexts, defaults to 1</td>
<td>(IntOpt) Number of ZeroMQ contexts, defaults to 1.</td>
</tr>
<tr>
<td>rpc_zmq_host = oslo</td>
@ -196,20 +212,24 @@
</tr>
<tr>
<td>rpc_zmq_ipc_dir = /var/run/openstack</td>
<td>(StrOpt) Directory for holding IPC sockets</td>
<td>(StrOpt) Directory for holding IPC sockets.</td>
</tr>
<tr>
<td>rpc_zmq_matchmaker = cinder.openstack.common.rpc.matchmaker.MatchMakerLocalhost</td>
<td>(StrOpt) MatchMaker driver</td>
<td>rpc_zmq_matchmaker = oslo.messaging._drivers.matchmaker.MatchMakerLocalhost</td>
<td>(StrOpt) MatchMaker driver.</td>
</tr>
<tr>
<td>rpc_zmq_port = 9501</td>
<td>(IntOpt) ZeroMQ receiver listening port</td>
<td>(IntOpt) ZeroMQ receiver listening port.</td>
</tr>
<tr>
<td>rpc_zmq_topic_backlog = None</td>
<td>(IntOpt) Maximum number of ingress messages to locally buffer per topic. Default is unlimited.</td>
</tr>
<tr>
<td>transport_url = None</td>
<td>(StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration.</td>
</tr>
<tr>
<td>volume_topic = cinder-volume</td>
<td>(StrOpt) the topic volume nodes listen on</td>
@ -219,22 +239,7 @@
</tr>
<tr>
<td>ringfile = /etc/oslo/matchmaker_ring.json</td>
<td>(StrOpt) Matchmaker ring file (JSON)</td>
</tr>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>port = 6379</td>
<td>(IntOpt) Use this port to connect to redis host.</td>
</tr>
<tr>
<td>password = None</td>
<td>(StrOpt) Password for Redis server. (optional)</td>
</tr>
<tr>
<td>transport_url = None</td>
<td>(StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration.</td>
<td>(StrOpt) Matchmaker ring file (JSON).</td>
</tr>
</tbody>
</table>

14
tools/autogenerate-config-flagmappings/cinder.flagmappings
View File

@ -48,8 +48,6 @@ db_driver database
debug common
default_availability_zone common
default_log_levels common
default_notification_level common
default_publisher_id common
default_timeout rpc
default_volume_type common
disable_process_locking common
@ -119,6 +117,7 @@ iser_ip_address storage
iser_num_targets storage
iser_port storage
iser_target_prefix storage
kombu_reconnect_delay rpc
kombu_ssl_ca_certs rpc
kombu_ssl_certfile rpc
kombu_ssl_keyfile rpc
@ -215,11 +214,13 @@ osapi_volume_extension api
osapi_volume_listen api
osapi_volume_listen_port api
osapi_volume_workers api
password rpc
pbm_default_policy vmware
periodic_fuzzy_delay common
periodic_interval common
policy_default_rule common
policy_file common
port rpc
publish_errors rpc
qpid_heartbeat rpc
qpid_hostname rpc
@ -238,6 +239,7 @@ quota_volumes quota
rabbit_ha_queues rpc
rabbit_host rpc
rabbit_hosts rpc
rabbit_login_method rpc
rabbit_max_retries rpc
rabbit_password rpc
rabbit_port rpc
@ -326,6 +328,7 @@ tcp_keepidle common
thres_avl_size_perc_start netapp_7mode_nfs netapp_cdot_nfs
thres_avl_size_perc_stop netapp_7mode_nfs netapp_cdot_nfs
transfer_api_class api
transport_url rpc
until_refresh common
use_default_quota_class quota
use_forwarded_for common
@ -408,14 +411,7 @@ fc-zone-manager/zone_driver zoning_manager
fc-zone-manager/zoning_policy zoning
keymgr/api_class keymgr
keymgr/fixed_key keymgr
matchmaker_redis/host common
matchmaker_redis/password common
matchmaker_redis/port common
matchmaker_ring/ringfile rpc
rpc_notifier2/topics common
ssl/ca_file ssl
ssl/cert_file ssl
ssl/key_file ssl
port rpc
password rpc
transport_url rpc