openstack/openstack-manuals
Code Issues Proposed changes

Merge "Updated flagmappings and tables for glance"

Browse Source
This commit is contained in:
Jenkins 2014-03-04 22:26:07 +00:00 committed by Gerrit Code Review
commit ae514e5e9b
18 changed files with 329 additions and 67 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
doc/common/tables/glance-amqp.xml Normal file
View File

@ -0,0 +1,59 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for amqp</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>amqp_auto_delete = False</td>
<td>(BoolOpt) Auto-delete queues in amqp.</td>
</tr>
<tr>
<td>amqp_durable_queues = False</td>
<td>(BoolOpt) Use durable queues in amqp.</td>
</tr>
<tr>
<td>notification_driver = []</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>
</tr>
<tr>
<td>rpc_backend = rabbit</td>
<td>(StrOpt) The messaging driver to use, defaults to rabbit. Other drivers include qpid and zmq.</td>
</tr>
<tr>
<td>rpc_conn_pool_size = 30</td>
<td>(IntOpt) Size of RPC connection pool</td>
</tr>
<tr>
<td>rpc_response_timeout = 60</td>
<td>(IntOpt) Seconds to wait for a response from a call</td>
</tr>
<tr>
<td>rpc_thread_pool_size = 64</td>
<td>(IntOpt) Size of RPC greenthread pool</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>
</tbody>
</table>
</para>

15
doc/common/tables/glance-api.xml
View File

@ -28,7 +28,7 @@
</tr> </tr>
<tr> <tr>
<td>default_publisher_id = image.localhost</td> <td>default_publisher_id = image.localhost</td>
<td>(StrOpt) Default publisher_id for outgoing notifications</td> <td>(StrOpt) Default publisher_id for outgoing notifications.</td>
</tr> </tr>
<tr> <tr>
<td>default_store = file</td> <td>default_store = file</td>
@ -47,9 +47,13 @@
<td>(IntOpt) Maximum size of image a user can upload in bytes. Defaults to 1099511627776 bytes (1 TB).</td> <td>(IntOpt) Maximum size of image a user can upload in bytes. Defaults to 1099511627776 bytes (1 TB).</td>
</tr> </tr>
<tr> <tr>
<td>known_stores = glance.store.filesystem.Store, glance.store.http.Store, glance.store.rbd.Store, glance.store.s3.Store, glance.store.swift.Store, glance.store.sheepdog.Store, glance.store.cinder.Store</td> <td>known_stores = glance.store.filesystem.Store, glance.store.http.Store, glance.store.rbd.Store, glance.store.s3.Store, glance.store.swift.Store, glance.store.sheepdog.Store, glance.store.cinder.Store, glance.store.vmware_datastore.Store</td>
<td>(ListOpt) List of which store classes and store class locations are currently known to glance at startup.</td> <td>(ListOpt) List of which store classes and store class locations are currently known to glance at startup.</td>
</tr> </tr>
<tr>
<td>location_strategy = location_order</td>
<td>(StrOpt) This value sets what strategy will be used to determine the image location order. Currently two strategies are packaged with Glance 'location_order' and 'store_type'.</td>
</tr>
<tr> <tr>
<td>owner_is_tenant = True</td> <td>owner_is_tenant = True</td>
<td>(BoolOpt) When true, this option sets the owner of an image to be the tenant. Otherwise, the owner of the image will be the authenticated user issuing the request.</td> <td>(BoolOpt) When true, this option sets the owner of an image to be the tenant. Otherwise, the owner of the image will be the authenticated user issuing the request.</td>
@ -66,6 +70,13 @@
<td>use_user_token = True</td> <td>use_user_token = True</td>
<td>(BoolOpt) Whether to pass through the user token when making requests to the registry.</td> <td>(BoolOpt) Whether to pass through the user token when making requests to the registry.</td>
</tr> </tr>
<tr>
<th colspan="2">[store_type_location_strategy]</th>
</tr>
<tr>
<td>store_type_preference = </td>
<td>(ListOpt) The store names to use to get store preference order. The name must be registered by one of the stores defined by the 'known_stores' config option. This option will be applied when you using 'store_type' option as image location strategy defined by the 'location_strategy' config option.</td>
</tr>
</tbody> </tbody>
</table> </table>
</para> </para>

10
doc/common/tables/glance-cinder.xml
View File

@ -20,23 +20,23 @@
</tr> </tr>
<tr> <tr>
<td>cinder_api_insecure = False</td> <td>cinder_api_insecure = False</td>
<td>(BoolOpt) Allow to perform insecure SSL requests to cinder</td> <td>(BoolOpt) Allow to perform insecure SSL requests to cinder.</td>
</tr> </tr>
<tr> <tr>
<td>cinder_ca_certificates_file = None</td> <td>cinder_ca_certificates_file = None</td>
<td>(StrOpt) Location of ca certicates file to use for cinder client requests.</td> <td>(StrOpt) Location of CA certicates file to use for cinder client requests.</td>
</tr> </tr>
<tr> <tr>
<td>cinder_catalog_info = volume:cinder:publicURL</td> <td>cinder_catalog_info = volume:cinder:publicURL</td>
<td>(StrOpt) Info to match when looking for cinder in the service catalog. Format is : separated values of the form: &lt;service_type&gt;:&lt;service_name&gt;:&lt;endpoint_type&gt;</td> <td>(StrOpt) Info to match when looking for cinder in the service catalog. Format is: separated values of the form: &lt;service_type&gt;:&lt;service_name&gt;:&lt;endpoint_type&gt;.</td>
</tr> </tr>
<tr> <tr>
<td>cinder_endpoint_template = None</td> <td>cinder_endpoint_template = None</td>
<td>(StrOpt) Override service catalog lookup with template for cinder endpoint e.g. http://localhost:8776/v1/%(project_id)s</td> <td>(StrOpt) Override service catalog lookup with template for cinder endpoint e.g. http://localhost:8776/v1/%(project_id)s.</td>
</tr> </tr>
<tr> <tr>
<td>cinder_http_retries = 3</td> <td>cinder_http_retries = 3</td>
<td>(IntOpt) Number of cinderclient retries on failed http calls</td> <td>(IntOpt) Number of cinderclient retries on failed http calls.</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>

9
doc/common/tables/glance-common.xml
View File

@ -80,7 +80,7 @@
</tr> </tr>
<tr> <tr>
<td>os_region_name = None</td> <td>os_region_name = None</td>
<td>(StrOpt) Region name of this node</td> <td>(StrOpt) Region name of this node.</td>
</tr> </tr>
<tr> <tr>
<td>property_protection_file = None</td> <td>property_protection_file = None</td>
@ -102,13 +102,6 @@
<td>workers = 1</td> <td>workers = 1</td>
<td>(IntOpt) The number of child process workers that will be created to service API requests.</td> <td>(IntOpt) The number of child process workers that will be created to service API requests.</td>
</tr> </tr>
<tr>
<th colspan="2">[database]</th>
</tr>
<tr>
<td>use_tpool = False</td>
<td>(BoolOpt) Enable the experimental use of thread pooling for all DB API calls</td>
</tr>
<tr> <tr>
<th colspan="2">[image_format]</th> <th colspan="2">[image_format]</th>
</tr> </tr>

51
doc/common/tables/glance-db.xml
View File

@ -15,17 +15,6 @@
</tr> </tr>
</thead> </thead>
<tbody> <tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>sqlite_db = glance.sqlite</td>
<td>(StrOpt) the filename to use with sqlite</td>
</tr>
<tr>
<td>sqlite_synchronous = True</td>
<td>(BoolOpt) If true, use synchronous mode for sqlite</td>
</tr>
<tr> <tr>
<th colspan="2">[database]</th> <th colspan="2">[database]</th>
</tr> </tr>
@ -34,7 +23,7 @@
<td>(StrOpt) The backend to use for db</td> <td>(StrOpt) The backend to use for db</td>
</tr> </tr>
<tr> <tr>
<td>connection = sqlite:////home/shaunm/Projects/glance/glance/openstack/common/db/$sqlite_db</td> <td>connection = None</td>
<td>(StrOpt) The SQLAlchemy connection string used to connect to the database</td> <td>(StrOpt) The SQLAlchemy connection string used to connect to the database</td>
</tr> </tr>
<tr> <tr>
@ -45,9 +34,25 @@
<td>connection_trace = False</td> <td>connection_trace = False</td>
<td>(BoolOpt) Add python stack traces to SQL as comment strings</td> <td>(BoolOpt) Add python stack traces to SQL as comment strings</td>
</tr> </tr>
<tr>
<td>db_inc_retry_interval = True</td>
<td>(BoolOpt) Whether to increase interval between db connection retries, up to db_max_retry_interval</td>
</tr>
<tr>
<td>db_max_retries = 20</td>
<td>(IntOpt) maximum db connection retries before error is raised. (setting -1 implies an infinite retry count)</td>
</tr>
<tr>
<td>db_max_retry_interval = 10</td>
<td>(IntOpt) max seconds between db connection retries, if db_inc_retry_interval is enabled</td>
</tr>
<tr>
<td>db_retry_interval = 1</td>
<td>(IntOpt) seconds between db connection retries</td>
</tr>
<tr> <tr>
<td>idle_timeout = 3600</td> <td>idle_timeout = 3600</td>
<td>(IntOpt) timeout before idle sql connections are reaped</td> <td>(IntOpt) Timeout before idle sql connections are reaped</td>
</tr> </tr>
<tr> <tr>
<td>max_overflow = None</td> <td>max_overflow = None</td>
@ -59,23 +64,35 @@
</tr> </tr>
<tr> <tr>
<td>max_retries = 10</td> <td>max_retries = 10</td>
<td>(IntOpt) maximum db connection retries during startup. (setting -1 implies an infinite retry count)</td> <td>(IntOpt) Maximum db connection retries during startup. (setting -1 implies an infinite retry count)</td>
</tr> </tr>
<tr> <tr>
<td>min_pool_size = 1</td> <td>min_pool_size = 1</td>
<td>(IntOpt) Minimum number of SQL connections to keep open in a pool</td> <td>(IntOpt) Minimum number of SQL connections to keep open in a pool</td>
</tr> </tr>
<tr>
<td>mysql_sql_mode = None</td>
<td>(StrOpt) The SQL mode to be used for MySQL sessions (default is empty, meaning do not override any server-side SQL mode setting)</td>
</tr>
<tr> <tr>
<td>pool_timeout = None</td> <td>pool_timeout = None</td>
<td>(IntOpt) If set, use this value for pool_timeout with sqlalchemy</td> <td>(IntOpt) If set, use this value for pool_timeout with sqlalchemy</td>
</tr> </tr>
<tr> <tr>
<td>retry_interval = 10</td> <td>retry_interval = 10</td>
<td>(IntOpt) interval between retries of opening a sql connection</td> <td>(IntOpt) Interval between retries of opening a sql connection</td>
</tr> </tr>
<tr> <tr>
<td>slave_connection = </td> <td>sqlite_db = glance.sqlite</td>
<td>(StrOpt) The SQLAlchemy connection string used to connect to the slave database</td> <td>(StrOpt) The file name to use with SQLite</td>
</tr>
<tr>
<td>sqlite_synchronous = True</td>
<td>(BoolOpt) If True, SQLite uses synchronous mode</td>
</tr>
<tr>
<td>use_db_reconnect = False</td>
<td>(BoolOpt) Enable the experimental use of database reconnect on connection lost</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>

4
doc/common/tables/glance-filesystem.xml
View File

@ -22,6 +22,10 @@
<td>filesystem_store_datadir = None</td> <td>filesystem_store_datadir = None</td>
<td>(StrOpt) Directory to which the Filesystem backend store writes images.</td> <td>(StrOpt) Directory to which the Filesystem backend store writes images.</td>
</tr> </tr>
<tr>
<td>filesystem_store_datadirs = None</td>
<td>(MultiStrOpt) List of directories and its priorities to which the Filesystem backend store writes images.</td>
</tr>
<tr> <tr>
<td>filesystem_store_metadata_file = None</td> <td>filesystem_store_metadata_file = None</td>
<td>(StrOpt) The path to a file which contains the metadata to be returned with any location associated with this store. The file must contain a valid JSON dict.</td> <td>(StrOpt) The path to a file which contains the metadata to be returned with any location associated with this store. The file must contain a valid JSON dict.</td>

4
doc/common/tables/glance-gridfs.xml
View File

@ -20,11 +20,11 @@
</tr> </tr>
<tr> <tr>
<td>mongodb_store_db = None</td> <td>mongodb_store_db = None</td>
<td>(StrOpt) Database to use</td> <td>(StrOpt) Database to use.</td>
</tr> </tr>
<tr> <tr>
<td>mongodb_store_uri = None</td> <td>mongodb_store_uri = None</td>
<td>(StrOpt) Hostname or IP address of the instance to connect to, or a mongodb URI, or a list of hostnames / mongodb URIs. If host is an IPv6 literal it must be enclosed in '[' and ']' characters following the RFC2732 URL syntax (e.g. '[::1]' for localhost)</td> <td>(StrOpt) Hostname or IP address of the instance to connect to, or a mongodb URI, or a list of hostnames / mongodb URIs. If host is an IPv6 literal it must be enclosed in '[' and ']' characters following the RFC2732 URL syntax (e.g. '[::1]' for localhost).</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>

4
doc/common/tables/glance-imagecache.xml
View File

@ -48,7 +48,7 @@
</tr> </tr>
<tr> <tr>
<td>image_cache_stall_time = 86400</td> <td>image_cache_stall_time = 86400</td>
<td>(IntOpt) The amount of time to let an image remain in the cache without being accessed</td> <td>(IntOpt) The amount of time to let an image remain in the cache without being accessed.</td>
</tr> </tr>
<tr> <tr>
<td>scrub_time = 0</td> <td>scrub_time = 0</td>
@ -56,7 +56,7 @@
</tr> </tr>
<tr> <tr>
<td>scrubber_datadir = /var/lib/glance/scrubber</td> <td>scrubber_datadir = /var/lib/glance/scrubber</td>
<td>(StrOpt) Directory that the scrubber will use to track information about what to delete. Make sure this is set in glance-api.conf and glance-scrubber.conf</td> <td>(StrOpt) Directory that the scrubber will use to track information about what to delete. Make sure this is set in glance-api.conf and glance-scrubber.conf.</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>

26
doc/common/tables/glance-logging.xml
View File

@ -23,12 +23,12 @@
<td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).</td> <td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).</td>
</tr> </tr>
<tr> <tr>
<td>default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, keystone=INFO, qpid=WARN, sqlalchemy=WARN, suds=INFO, iso8601=WARN</td> <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> <td>(ListOpt) List of logger=LEVEL pairs</td>
</tr> </tr>
<tr> <tr>
<td>fatal_deprecations = False</td> <td>fatal_deprecations = False</td>
<td>(BoolOpt) make deprecations fatal</td> <td>(BoolOpt) Make deprecations fatal</td>
</tr> </tr>
<tr> <tr>
<td>instance_format = "[instance: %(uuid)s] "</td> <td>instance_format = "[instance: %(uuid)s] "</td>
@ -59,32 +59,36 @@
<td>(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.</td> <td>(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.</td>
</tr> </tr>
<tr> <tr>
<td>logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user)s %(tenant)s] %(instance)s%(message)s</td> <td>logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s</td>
<td>(StrOpt) format string to use for log messages with context</td> <td>(StrOpt) Format string to use for log messages with context</td>
</tr> </tr>
<tr> <tr>
<td>logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d</td> <td>logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d</td>
<td>(StrOpt) data to append to log format when level is DEBUG</td> <td>(StrOpt) Data to append to log format when level is DEBUG</td>
</tr> </tr>
<tr> <tr>
<td>logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s</td> <td>logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s</td>
<td>(StrOpt) format string to use for log messages without context</td> <td>(StrOpt) Format string to use for log messages without context</td>
</tr> </tr>
<tr> <tr>
<td>logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s</td> <td>logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s</td>
<td>(StrOpt) prefix each line of exception output with this format</td> <td>(StrOpt) Prefix each line of exception output with this format</td>
</tr> </tr>
<tr> <tr>
<td>publish_errors = False</td> <td>publish_errors = False</td>
<td>(BoolOpt) publish error events</td> <td>(BoolOpt) Publish error events</td>
</tr> </tr>
<tr> <tr>
<td>syslog-log-facility = LOG_USER</td> <td>syslog-log-facility = LOG_USER</td>
<td>(StrOpt) syslog facility to receive log lines</td> <td>(StrOpt) Syslog facility to receive log lines</td>
</tr> </tr>
<tr> <tr>
<td>use-syslog = False</td> <td>use-syslog = False</td>
<td>(BoolOpt) Use syslog for logging.</td> <td>(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and then will be changed in J to honor RFC5424</td>
</tr>
<tr>
<td>use-syslog-rfc-format = False</td>
<td>(BoolOpt) (Optional) Use syslog rfc5424 format for logging. If enabled, will add APP-NAME (RFC5424) before the MSG part of the syslog message. The old format without APP-NAME is deprecated in I, and will be removed in J.</td>
</tr> </tr>
<tr> <tr>
<td>use_stderr = True</td> <td>use_stderr = True</td>

38
doc/common/tables/glance-matchmaker.xml Normal file
View File

@ -0,0 +1,38 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for matchmaker</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>matchmaker_heartbeat_freq = 300</td>
<td>(IntOpt) Heartbeat frequency</td>
</tr>
<tr>
<td>matchmaker_heartbeat_ttl = 600</td>
<td>(IntOpt) Heartbeat time-to-live.</td>
</tr>
<tr>
<th colspan="2">[matchmaker_ring]</th>
</tr>
<tr>
<td>ringfile = /etc/oslo/matchmaker_ring.json</td>
<td>(StrOpt) Matchmaker ring file (JSON)</td>
</tr>
</tbody>
</table>
</para>

2
doc/common/tables/glance-qpid.xml
View File

@ -23,7 +23,7 @@
<td>(IntOpt) Seconds between connection keepalive heartbeats</td> <td>(IntOpt) Seconds between connection keepalive heartbeats</td>
</tr> </tr>
<tr> <tr>
<td>qpid_hostname = localhost</td> <td>qpid_hostname = oslo</td>
<td>(StrOpt) Qpid broker hostname</td> <td>(StrOpt) Qpid broker hostname</td>
</tr> </tr>
<tr> <tr>

22
doc/common/tables/glance-rabbitmq.xml
View File

@ -18,6 +18,10 @@
<tr> <tr>
<th colspan="2">[DEFAULT]</th> <th colspan="2">[DEFAULT]</th>
</tr> </tr>
<tr>
<td>control_exchange = openstack</td>
<td>(StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.</td>
</tr>
<tr> <tr>
<td>fake_rabbit = False</td> <td>fake_rabbit = False</td>
<td>(BoolOpt) If passed, use a fake RabbitMQ provider</td> <td>(BoolOpt) If passed, use a fake RabbitMQ provider</td>
@ -40,10 +44,10 @@
</tr> </tr>
<tr> <tr>
<td>rabbit_ha_queues = False</td> <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>
<tr> <tr>
<td>rabbit_host = localhost</td> <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>
<tr> <tr>
@ -52,11 +56,11 @@
</tr> </tr>
<tr> <tr>
<td>rabbit_max_retries = 0</td> <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>
<tr> <tr>
<td>rabbit_password = guest</td> <td>rabbit_password = guest</td>
<td>(StrOpt) the RabbitMQ password</td> <td>(StrOpt) The RabbitMQ password</td>
</tr> </tr>
<tr> <tr>
<td>rabbit_port = 5672</td> <td>rabbit_port = 5672</td>
@ -64,23 +68,23 @@
</tr> </tr>
<tr> <tr>
<td>rabbit_retry_backoff = 2</td> <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>
<tr> <tr>
<td>rabbit_retry_interval = 1</td> <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>
<tr> <tr>
<td>rabbit_use_ssl = False</td> <td>rabbit_use_ssl = False</td>
<td>(BoolOpt) connect over SSL for RabbitMQ</td> <td>(BoolOpt) Connect over SSL for RabbitMQ</td>
</tr> </tr>
<tr> <tr>
<td>rabbit_userid = guest</td> <td>rabbit_userid = guest</td>
<td>(StrOpt) the RabbitMQ userid</td> <td>(StrOpt) The RabbitMQ userid</td>
</tr> </tr>
<tr> <tr>
<td>rabbit_virtual_host = /</td> <td>rabbit_virtual_host = /</td>
<td>(StrOpt) the RabbitMQ virtual host</td> <td>(StrOpt) The RabbitMQ virtual host</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>

4
doc/common/tables/glance-rbd.xml
View File

@ -20,7 +20,7 @@
</tr> </tr>
<tr> <tr>
<td>rbd_store_ceph_conf = /etc/ceph/ceph.conf</td> <td>rbd_store_ceph_conf = /etc/ceph/ceph.conf</td>
<td>(StrOpt) Ceph configuration file path. If &lt;None&gt;, librados will locate the default config. If using cephx authentication, this file should include a reference to the right keyring in a client.&lt;USER&gt; section</td> <td>(StrOpt) Ceph configuration file path. If &lt;None&gt;, librados will locate the default config. If using cephx authentication, this file should include a reference to the right keyring in a client.&lt;USER&gt; section.</td>
</tr> </tr>
<tr> <tr>
<td>rbd_store_chunk_size = 8</td> <td>rbd_store_chunk_size = 8</td>
@ -32,7 +32,7 @@
</tr> </tr>
<tr> <tr>
<td>rbd_store_user = None</td> <td>rbd_store_user = None</td>
<td>(StrOpt) RADOS user to authenticate as (only applicable if using Cephx. If &lt;None&gt;, a default will be chosen based on the client. section in rbd_store_ceph_conf)</td> <td>(StrOpt) RADOS user to authenticate as (only applicable if using Cephx. If &lt;None&gt;, a default will be chosen based on the client. section in rbd_store_ceph_conf).</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>

35
doc/common/tables/glance-redis.xml Normal file
View File

@ -0,0 +1,35 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for redis</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</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>
</tbody>
</table>
</para>

2
doc/common/tables/glance-rpc.xml
View File

@ -19,7 +19,7 @@
<th colspan="2">[DEFAULT]</th> <th colspan="2">[DEFAULT]</th>
</tr> </tr>
<tr> <tr>
<td>allowed_rpc_exception_modules = openstack.common.exception, glance.common.exception, exceptions</td> <td>allowed_rpc_exception_modules = oslo.messaging.exceptions, nova.exception, cinder.exception, exceptions</td>
<td>(ListOpt) Modules of exceptions that are permitted to be recreatedupon receiving exception data from an rpc call.</td> <td>(ListOpt) Modules of exceptions that are permitted to be recreatedupon receiving exception data from an rpc call.</td>
</tr> </tr>
</tbody> </tbody>

10
doc/common/tables/glance-swift.xml
View File

@ -36,7 +36,7 @@
</tr> </tr>
<tr> <tr>
<td>swift_store_auth_version = 2</td> <td>swift_store_auth_version = 2</td>
<td>(StrOpt) Version of the authentication service to use. Valid versions are 2 for keystone and 1 for swauth and rackspace</td> <td>(StrOpt) Version of the authentication service to use. Valid versions are 2 for keystone and 1 for swauth and rackspace.</td>
</tr> </tr>
<tr> <tr>
<td>swift_store_container = glance</td> <td>swift_store_container = glance</td>
@ -60,7 +60,7 @@
</tr> </tr>
<tr> <tr>
<td>swift_store_large_object_size = 5120</td> <td>swift_store_large_object_size = 5120</td>
<td>(IntOpt) The size, in MB, that Glance will start chunking image files and do a large object manifest in Swift</td> <td>(IntOpt) The size, in MB, that Glance will start chunking image files and do a large object manifest in Swift.</td>
</tr> </tr>
<tr> <tr>
<td>swift_store_multi_tenant = False</td> <td>swift_store_multi_tenant = False</td>
@ -70,6 +70,10 @@
<td>swift_store_region = None</td> <td>swift_store_region = None</td>
<td>(StrOpt) The region of the swift endpoint to be used for single tenant. This setting is only necessary if the tenant has multiple swift endpoints.</td> <td>(StrOpt) The region of the swift endpoint to be used for single tenant. This setting is only necessary if the tenant has multiple swift endpoints.</td>
</tr> </tr>
<tr>
<td>swift_store_retry_get_count = 0</td>
<td>(IntOpt) The number of times a Swift download will be retried before the request fails.</td>
</tr>
<tr> <tr>
<td>swift_store_service_type = object-store</td> <td>swift_store_service_type = object-store</td>
<td>(StrOpt) A string giving the service type of the swift service to use. This setting is only used if swift_store_auth_version is 2.</td> <td>(StrOpt) A string giving the service type of the swift service to use. This setting is only used if swift_store_auth_version is 2.</td>
@ -80,7 +84,7 @@
</tr> </tr>
<tr> <tr>
<td>swift_store_user = None</td> <td>swift_store_user = None</td>
<td>(StrOpt) The user to authenticate against the Swift authentication service</td> <td>(StrOpt) The user to authenticate against the Swift authentication service.</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>

59
doc/common/tables/glance-vmware.xml Normal file
View File

@ -0,0 +1,59 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for vmware</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>vmware_api_insecure = False</td>
<td>(BoolOpt) Allow to perform insecure SSL requests to ESX/VC.</td>
</tr>
<tr>
<td>vmware_api_retry_count = 10</td>
<td>(IntOpt) Number of times VMware ESX/VC server API must be retried upon connection related issues.</td>
</tr>
<tr>
<td>vmware_datacenter_path = ha-datacenter</td>
<td>(StrOpt) Inventory path to a datacenter. If the vmware_server_host specified is an ESX/ESXi, the vmware_datacenter_path is optional. If specified, it should be "ha-datacenter".</td>
</tr>
<tr>
<td>vmware_datastore_name = None</td>
<td>(StrOpt) Datastore associated with the datacenter.</td>
</tr>
<tr>
<td>vmware_server_host = None</td>
<td>(StrOpt) ESX/ESXi or vCenter Server target system. The server value can be an IP address or a DNS name.</td>
</tr>
<tr>
<td>vmware_server_password = None</td>
<td>(StrOpt) Password for authenticating with VMware ESX/VC server.</td>
</tr>
<tr>
<td>vmware_server_username = None</td>
<td>(StrOpt) Username for authenticating with VMware ESX/VC server.</td>
</tr>
<tr>
<td>vmware_store_image_dir = /openstack_glance</td>
<td>(StrOpt) The name of the directory where the glance images will be stored in the VMware datastore.</td>
</tr>
<tr>
<td>vmware_task_poll_interval = 5</td>
<td>(IntOpt) The interval used for polling remote tasks invoked on VMware ESX/VC server.</td>
</tr>
</tbody>
</table>
</para>

42
tools/autogenerate-config-flagmappings/glance.flagmappings
View File

@ -5,6 +5,8 @@ admin_user registry
allow_additional_image_properties common allow_additional_image_properties common
allow_anonymous_access api allow_anonymous_access api
allowed_rpc_exception_modules rpc allowed_rpc_exception_modules rpc
amqp_auto_delete amqp
amqp_durable_queues amqp
api_limit_max common api_limit_max common
auth_region registry auth_region registry
auth_strategy registry auth_strategy registry
@ -22,6 +24,7 @@ cinder_endpoint_template cinder
cinder_http_retries cinder cinder_http_retries cinder
cleanup_scrubber imagecache cleanup_scrubber imagecache
cleanup_scrubber_time imagecache cleanup_scrubber_time imagecache
control_exchange rabbitmq
data_api common data_api common
debug logging debug logging
default_log_levels logging default_log_levels logging
@ -35,7 +38,9 @@ eventlet_hub wsgi
fake_rabbit rabbitmq fake_rabbit rabbitmq
fatal_deprecations logging fatal_deprecations logging
filesystem_store_datadir filesystem filesystem_store_datadir filesystem
filesystem_store_datadirs filesystem
filesystem_store_metadata_file filesystem filesystem_store_metadata_file filesystem
host redis
image_cache_dir imagecache image_cache_dir imagecache
image_cache_driver imagecache image_cache_driver imagecache
image_cache_max_size imagecache image_cache_max_size imagecache
@ -55,6 +60,7 @@ kombu_ssl_certfile rabbitmq
kombu_ssl_keyfile rabbitmq kombu_ssl_keyfile rabbitmq
kombu_ssl_version rabbitmq kombu_ssl_version rabbitmq
limit_param_default common limit_param_default common
location_strategy api
lock_path common lock_path common
log-config-append logging log-config-append logging
log-date-format logging log-date-format logging
@ -65,15 +71,21 @@ logging_context_format_string logging
logging_debug_format_suffix logging logging_debug_format_suffix logging
logging_default_format_string logging logging_default_format_string logging
logging_exception_prefix logging logging_exception_prefix logging
matchmaker_heartbeat_freq matchmaker
matchmaker_heartbeat_ttl matchmaker
max_header_line wsgi max_header_line wsgi
metadata_encryption_key common metadata_encryption_key common
mongodb_store_db gridfs mongodb_store_db gridfs
mongodb_store_uri gridfs mongodb_store_uri gridfs
notification_driver amqp
notification_topics amqp
notifier_strategy common notifier_strategy common
os_region_name common os_region_name common
owner_is_tenant api owner_is_tenant api
password redis
policy_default_rule policy policy_default_rule policy
policy_file policy policy_file policy
port redis
property_protection_file common property_protection_file common
property_protection_rule_format common property_protection_rule_format common
publish_errors logging publish_errors logging
@ -112,7 +124,11 @@ registry_client_protocol registry
registry_client_timeout registry registry_client_timeout registry
registry_host registry registry_host registry
registry_port registry registry_port registry
rpc_backend amqp
rpc_cast_timeout zmq rpc_cast_timeout zmq
rpc_conn_pool_size amqp
rpc_response_timeout amqp
rpc_thread_pool_size amqp
rpc_zmq_bind_address zmq rpc_zmq_bind_address zmq
rpc_zmq_contexts zmq rpc_zmq_contexts zmq
rpc_zmq_host zmq rpc_zmq_host zmq
@ -135,8 +151,6 @@ sheepdog_store_chunk_size sheepdog
sheepdog_store_port sheepdog sheepdog_store_port sheepdog
show_image_direct_url common show_image_direct_url common
show_multiple_locations api show_multiple_locations api
sqlite_db db
sqlite_synchronous db
swift_enable_snet swift swift_enable_snet swift
swift_store_admin_tenants swift swift_store_admin_tenants swift
swift_store_auth_address swift swift_store_auth_address swift
@ -150,32 +164,52 @@ swift_store_large_object_chunk_size swift
swift_store_large_object_size swift swift_store_large_object_size swift
swift_store_multi_tenant swift swift_store_multi_tenant swift
swift_store_region swift swift_store_region swift
swift_store_retry_get_count swift
swift_store_service_type swift swift_store_service_type swift
swift_store_ssl_compression swift swift_store_ssl_compression swift
swift_store_user swift swift_store_user swift
syslog-log-facility logging syslog-log-facility logging
tcp_keepidle wsgi tcp_keepidle wsgi
transport_url amqp
use-syslog logging use-syslog logging
use-syslog-rfc-format logging
use_stderr logging use_stderr logging
use_user_token api use_user_token api
user_storage_quota common user_storage_quota common
verbose logging verbose logging
vmware_api_insecure vmware
vmware_api_retry_count vmware
vmware_datacenter_path vmware
vmware_datastore_name vmware
vmware_server_host vmware
vmware_server_password vmware
vmware_server_username vmware
vmware_store_image_dir vmware
vmware_task_poll_interval vmware
workers common workers common
database/backend db database/backend db
database/connection db database/connection db
database/connection_debug db database/connection_debug db
database/connection_trace db database/connection_trace db
database/db_inc_retry_interval db
database/db_max_retries db
database/db_max_retry_interval db
database/db_retry_interval db
database/idle_timeout db database/idle_timeout db
database/max_overflow db database/max_overflow db
database/max_pool_size db database/max_pool_size db
database/max_retries db database/max_retries db
database/min_pool_size db database/min_pool_size db
database/mysql_sql_mode db
database/pool_timeout db database/pool_timeout db
database/retry_interval db database/retry_interval db
database/slave_connection db database/sqlite_db db
database/use_tpool common database/sqlite_synchronous db
database/use_db_reconnect db
image_format/container_formats common image_format/container_formats common
image_format/disk_formats common image_format/disk_formats common
matchmaker_ring/ringfile matchmaker
paste_deploy/config_file paste paste_deploy/config_file paste
paste_deploy/flavor paste paste_deploy/flavor paste
store_type_location_strategy/store_type_preference api
task/task_time_to_live common task/task_time_to_live common