Merge "First generation of ceilometer config reference tables"

This commit is contained in:
Jenkins 2014-03-05 17:47:06 +00:00 committed by Gerrit Code Review
commit f96a71db59
18 changed files with 1113 additions and 99 deletions

View File

@ -0,0 +1,55 @@
<?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 alarm</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">[alarm]</th>
</tr>
<tr>
<td>evaluation_interval = 60</td>
<td>(IntOpt) Period of evaluation cycle, should be &gt;= than configured pipeline interval for collection of underlying metrics.</td>
</tr>
<tr>
<td>evaluation_service = ceilometer.alarm.service.SingletonAlarmService</td>
<td>(StrOpt) Class to launch as alarm evaluation service.</td>
</tr>
<tr>
<td>notifier_rpc_topic = alarm_notifier</td>
<td>(StrOpt) The topic that ceilometer uses for alarm notifier messages.</td>
</tr>
<tr>
<td>partition_rpc_topic = alarm_partition_coordination</td>
<td>(StrOpt) The topic that ceilometer uses for alarm partition coordination messages.</td>
</tr>
<tr>
<td>record_history = True</td>
<td>(BoolOpt) Record alarm change events.</td>
</tr>
<tr>
<td>rest_notifier_certificate_file = </td>
<td>(StrOpt) SSL Client certificate for REST notifier.</td>
</tr>
<tr>
<td>rest_notifier_certificate_key = </td>
<td>(StrOpt) SSL Client private key for REST notifier.</td>
</tr>
<tr>
<td>rest_notifier_ssl_verify = True</td>
<td>(BoolOpt) Whether to verify the SSL Server certificate when calling alarm action.</td>
</tr>
</tbody>
</table>
</para>

View File

@ -0,0 +1,39 @@
<?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>
</tbody>
</table>
</para>

View File

@ -0,0 +1,62 @@
<?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 api</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>enable_v1_api = True</td>
<td>(BoolOpt) Deploy the deprecated v1 API.</td>
</tr>
<tr>
<td>max_request_body_size = 114688</td>
<td>(IntOpt) The maximum body size per request, in bytes</td>
</tr>
<tr>
<td>pipeline_cfg_file = pipeline.yaml</td>
<td>(StrOpt) Configuration file for pipeline definition.</td>
</tr>
<tr>
<td>policy_default_rule = default</td>
<td>(StrOpt) Rule enforced when requested rule is not found</td>
</tr>
<tr>
<td>policy_file = policy.json</td>
<td>(StrOpt) JSON file containing policy</td>
</tr>
<tr>
<td>reserved_metadata_length = 256</td>
<td>(IntOpt) Limit on length of reserved metadata values.</td>
</tr>
<tr>
<td>reserved_metadata_namespace = metering.</td>
<td>(ListOpt) List of metadata prefixes reserved for metering use.</td>
</tr>
<tr>
<th colspan="2">[api]</th>
</tr>
<tr>
<td>host = 0.0.0.0</td>
<td>(StrOpt) The listen IP for the ceilometer API server.</td>
</tr>
<tr>
<td>port = 8777</td>
<td>(IntOpt) The port for the ceilometer API server.</td>
</tr>
</tbody>
</table>
</para>

View File

@ -0,0 +1,66 @@
<?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 auth</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>auth_strategy = keystone</td>
<td>(StrOpt) The strategy to use for auth: noauth or keystone.</td>
</tr>
<tr>
<th colspan="2">[service_credentials]</th>
</tr>
<tr>
<td>insecure = False</td>
<td>(BoolOpt) Disables X.509 certificate validation when an SSL connection to Identity Service is established.</td>
</tr>
<tr>
<td>os-auth-url = http://localhost:5000/v2.0</td>
<td>(StrOpt) Auth URL to use for OpenStack service access.</td>
</tr>
<tr>
<td>os-cacert = None</td>
<td>(StrOpt) Certificate chain for SSL validation.</td>
</tr>
<tr>
<td>os-endpoint-type = publicURL</td>
<td>(StrOpt) Type of endpoint in Identity service catalog to use for communication with OpenStack services.</td>
</tr>
<tr>
<td>os-password = admin</td>
<td>(StrOpt) Password to use for OpenStack service access.</td>
</tr>
<tr>
<td>os-region-name = None</td>
<td>(StrOpt) Region name to use for OpenStack service endpoints.</td>
</tr>
<tr>
<td>os-tenant-id = </td>
<td>(StrOpt) Tenant ID to use for OpenStack service access.</td>
</tr>
<tr>
<td>os-tenant-name = admin</td>
<td>(StrOpt) Tenant name to use for OpenStack service access.</td>
</tr>
<tr>
<td>os-username = ceilometer</td>
<td>(StrOpt) User name to use for OpenStack service access.</td>
</tr>
</tbody>
</table>
</para>

View File

@ -0,0 +1,46 @@
<?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 collector</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">[collector]</th>
</tr>
<tr>
<td>udp_address = 0.0.0.0</td>
<td>(StrOpt) Address to which the UDP socket is bound. Set to an empty string to disable.</td>
</tr>
<tr>
<td>udp_port = 4952</td>
<td>(IntOpt) Port to which the UDP socket is bound.</td>
</tr>
<tr>
<th colspan="2">[dispatcher_file]</th>
</tr>
<tr>
<td>backup_count = 0</td>
<td>(IntOpt) The max number of the files to keep.</td>
</tr>
<tr>
<td>file_path = None</td>
<td>(StrOpt) Name and the location of the file to record meters.</td>
</tr>
<tr>
<td>max_bytes = 0</td>
<td>(IntOpt) The max size of the file.</td>
</tr>
</tbody>
</table>
</para>

View File

@ -0,0 +1,39 @@
<?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 common</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>backdoor_port = None</td>
<td>(StrOpt) Enable eventlet backdoor. Acceptable values are 0, &lt;port&gt;, and &lt;start&gt;:&lt;end&gt;, where 0 results in listening on a random tcp port number; &lt;port&gt; results in listening on the specified port number (and not enabling backdoor if that port is in use); and &lt;start&gt;:&lt;end&gt; results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file.</td>
</tr>
<tr>
<td>disable_process_locking = False</td>
<td>(BoolOpt) Whether to disable inter-process locks.</td>
</tr>
<tr>
<td>fatal_deprecations = False</td>
<td>(BoolOpt) Make deprecations fatal</td>
</tr>
<tr>
<td>lock_path = None</td>
<td>(StrOpt) Directory to use for lock files.</td>
</tr>
</tbody>
</table>
</para>

View File

@ -0,0 +1,94 @@
<?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 database</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>database_connection = None</td>
<td>(StrOpt) DEPRECATED - Database connection string.</td>
</tr>
<tr>
<td>mysql_engine = InnoDB</td>
<td>(StrOpt) MySQL engine to use.</td>
</tr>
<tr>
<td>sqlite_db = ceilometer.sqlite</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>
<th colspan="2">[database]</th>
</tr>
<tr>
<td>backend = sqlalchemy</td>
<td>(StrOpt) The backend to use for db</td>
</tr>
<tr>
<td>connection = sqlite:////usr/lib/python/site-packages/ceilometer/openstack/common/db/$sqlite_db</td>
<td>(StrOpt) The SQLAlchemy connection string used to connect to the database</td>
</tr>
<tr>
<td>connection_debug = 0</td>
<td>(IntOpt) Verbosity of SQL debugging information. 0=None, 100=Everything</td>
</tr>
<tr>
<td>connection_trace = False</td>
<td>(BoolOpt) Add python stack traces to SQL as comment strings</td>
</tr>
<tr>
<td>idle_timeout = 3600</td>
<td>(IntOpt) Timeout before idle sql connections are reaped</td>
</tr>
<tr>
<td>max_overflow = None</td>
<td>(IntOpt) If set, use this value for max_overflow with sqlalchemy</td>
</tr>
<tr>
<td>max_pool_size = None</td>
<td>(IntOpt) Maximum number of SQL connections to keep open in a pool</td>
</tr>
<tr>
<td>max_retries = 10</td>
<td>(IntOpt) Maximum db connection retries during startup. (setting -1 implies an infinite retry count)</td>
</tr>
<tr>
<td>min_pool_size = 1</td>
<td>(IntOpt) Minimum number of SQL connections to keep open in a pool</td>
</tr>
<tr>
<td>pool_timeout = None</td>
<td>(IntOpt) If set, use this value for pool_timeout with sqlalchemy</td>
</tr>
<tr>
<td>retry_interval = 10</td>
<td>(IntOpt) Interval between retries of opening a sql connection</td>
</tr>
<tr>
<td>slave_connection = </td>
<td>(StrOpt) The SQLAlchemy connection string used to connect to the slave database</td>
</tr>
<tr>
<td>time_to_live = -1</td>
<td>(IntOpt) Number of seconds that samples are kept in the database for (&lt;= 0 means forever).</td>
</tr>
</tbody>
</table>
</para>

View File

@ -0,0 +1,42 @@
<?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 events</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">[event]</th>
</tr>
<tr>
<td>definitions_cfg_file = event_definitions.yaml</td>
<td>(StrOpt) Configuration file for event definitions.</td>
</tr>
<tr>
<td>drop_unmatched_notifications = False</td>
<td>(BoolOpt) Drop notifications if no event definition matches. (Otherwise, we convert them with just the default traits)</td>
</tr>
<tr>
<th colspan="2">[notification]</th>
</tr>
<tr>
<td>ack_on_event_error = True</td>
<td>(BoolOpt) Acknowledge message when event persistence fails.</td>
</tr>
<tr>
<td>store_events = False</td>
<td>(BoolOpt) Save event details.</td>
</tr>
</tbody>
</table>
</para>

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 exchange</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>cinder_control_exchange = cinder</td>
<td>(StrOpt) Exchange name for Cinder notifications.</td>
</tr>
<tr>
<td>control_exchange = openstack</td>
<td>(StrOpt) AMQP exchange to connect to if using RabbitMQ or Qpid</td>
</tr>
<tr>
<td>default_publisher_id = None</td>
<td>(StrOpt) Default publisher_id for outgoing notifications</td>
</tr>
<tr>
<td>glance_control_exchange = glance</td>
<td>(StrOpt) Exchange name for Glance notifications.</td>
</tr>
<tr>
<td>heat_control_exchange = heat</td>
<td>(StrOpt) Exchange name for Heat notifications</td>
</tr>
<tr>
<td>http_control_exchanges = ['nova', 'glance', 'neutron', 'cinder']</td>
<td>(MultiStrOpt) Exchanges name to listen for notifications.</td>
</tr>
<tr>
<td>neutron_control_exchange = neutron</td>
<td>(StrOpt) Exchange name for Neutron notifications.</td>
</tr>
<tr>
<td>nova_control_exchange = nova</td>
<td>(StrOpt) Exchange name for Nova notifications.</td>
</tr>
<tr>
<td>sample_source = openstack</td>
<td>(StrOpt) Source for samples emitted on this instance.</td>
</tr>
</tbody>
</table>
</para>

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 inspector</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>hypervisor_inspector = libvirt</td>
<td>(StrOpt) Inspector to use for inspecting the hypervisor layer.</td>
</tr>
<tr>
<td>libvirt_type = kvm</td>
<td>(StrOpt) Libvirt domain type (valid options are: kvm, lxc, qemu, uml, xen).</td>
</tr>
<tr>
<td>libvirt_uri = </td>
<td>(StrOpt) Override the default libvirt URI (which is dependent on libvirt_type).</td>
</tr>
</tbody>
</table>
</para>

View File

@ -0,0 +1,103 @@
<?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 logging</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>debug = False</td>
<td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).</td>
</tr>
<tr>
<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>instance_format = "[instance: %(uuid)s] "</td>
<td>(StrOpt) If an instance is passed with the log message, format it like this</td>
</tr>
<tr>
<td>instance_uuid_format = "[instance: %(uuid)s] "</td>
<td>(StrOpt) If an instance UUID is passed with the log message, format it like this</td>
</tr>
<tr>
<td>log-config-append = None</td>
<td>(StrOpt) The name of logging configuration file. It does not disable existing loggers, but just appends specified logging configuration to any other existing logging options. Please see the Python logging module documentation for details on logging configuration files.</td>
</tr>
<tr>
<td>log-date-format = %Y-%m-%d %H:%M:%S</td>
<td>(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s</td>
</tr>
<tr>
<td>log-dir = None</td>
<td>(StrOpt) (Optional) The base directory used for relative --log-file paths</td>
</tr>
<tr>
<td>log-file = None</td>
<td>(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.</td>
</tr>
<tr>
<td>log-format = None</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>
<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>
</tr>
<tr>
<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>
</tr>
<tr>
<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>
</tr>
<tr>
<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>
</tr>
<tr>
<td>publish_errors = False</td>
<td>(BoolOpt) Publish error events</td>
</tr>
<tr>
<td>syslog-log-facility = LOG_USER</td>
<td>(StrOpt) Syslog facility to receive log lines</td>
</tr>
<tr>
<td>use-syslog = False</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>
<td>use_stderr = True</td>
<td>(BoolOpt) Log output to standard error</td>
</tr>
<tr>
<td>verbose = False</td>
<td>(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level).</td>
</tr>
</tbody>
</table>
</para>

View File

@ -0,0 +1,63 @@
<?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 qpid</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>qpid_heartbeat = 60</td>
<td>(IntOpt) Seconds between connection keepalive heartbeats</td>
</tr>
<tr>
<td>qpid_hostname = oslo</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>
</tr>
<tr>
<td>qpid_password = </td>
<td>(StrOpt) Password for qpid connection</td>
</tr>
<tr>
<td>qpid_port = 5672</td>
<td>(IntOpt) Qpid broker port</td>
</tr>
<tr>
<td>qpid_protocol = tcp</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>
</tr>
<tr>
<td>qpid_tcp_nodelay = True</td>
<td>(BoolOpt) Disable Nagle algorithm</td>
</tr>
<tr>
<td>qpid_topology_version = 1</td>
<td>(IntOpt) The qpid topology version to use. Version 1 is what was originally used by impl_qpid. Version 2 includes some backwards-incompatible changes that allow broker federation to work. Users should update to version 2 when they are able to take everything down, as it requires a clean break.</td>
</tr>
<tr>
<td>qpid_username = </td>
<td>(StrOpt) Username for qpid connection</td>
</tr>
</tbody>
</table>
</para>

View File

@ -0,0 +1,87 @@
<?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 rabbitmq</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>fake_rabbit = False</td>
<td>(BoolOpt) If passed, use a fake RabbitMQ provider</td>
</tr>
<tr>
<td>kombu_ssl_ca_certs = </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>
</tr>
<tr>
<td>kombu_ssl_keyfile = </td>
<td>(StrOpt) SSL key file (valid only if SSL enabled)</td>
</tr>
<tr>
<td>kombu_ssl_version = </td>
<td>(StrOpt) If SSL is enabled, the SSL version to use. Valid values are TLSv1, SSLv23 and SSLv3. SSLv2 might be available on some distributions.</td>
</tr>
<tr>
<td>rabbit_ha_queues = False</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>
</tr>
<tr>
<td>rabbit_hosts = $rabbit_host:$rabbit_port</td>
<td>(ListOpt) RabbitMQ HA cluster host:port pairs</td>
</tr>
<tr>
<td>rabbit_max_retries = 0</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>
</tr>
<tr>
<td>rabbit_port = 5672</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>
</tr>
<tr>
<td>rabbit_retry_interval = 1</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>
</tr>
<tr>
<td>rabbit_userid = guest</td>
<td>(StrOpt) The RabbitMQ userid</td>
</tr>
<tr>
<td>rabbit_virtual_host = /</td>
<td>(StrOpt) The RabbitMQ virtual host</td>
</tr>
</tbody>
</table>
</para>

View File

@ -0,0 +1,57 @@
<?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 = oslo</td>
<td>(StrOpt) Name of this node, which must be valid in an AMQP key. Can be an opaque identifier. For ZeroMQ only, must be a valid host name, FQDN, or IP address.</td>
</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_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">[matchmaker_ring]</th>
</tr>
<tr>
<td>ringfile = /etc/oslo/matchmaker_ring.json</td>
<td>(StrOpt) Matchmaker ring file (JSON)</td>
</tr>
</tbody>
</table>
</para>

View File

@ -0,0 +1,100 @@
<?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 rpc</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>allowed_rpc_exception_modules = nova.exception, cinder.exception, exceptions</td>
<td>(ListOpt) Modules of exceptions that are permitted to be recreated upon receiving exception data from an rpc call.</td>
</tr>
<tr>
<td>dispatcher = ['database']</td>
<td>(MultiStrOpt) Dispatcher to process data.</td>
</tr>
<tr>
<td>rpc_backend = ceilometer.openstack.common.rpc.impl_kombu</td>
<td>(StrOpt) The messaging module to use, defaults to kombu.</td>
</tr>
<tr>
<td>rpc_cast_timeout = 30</td>
<td>(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_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 call or multicall</td>
</tr>
<tr>
<td>rpc_thread_pool_size = 64</td>
<td>(IntOpt) Size of RPC thread pool</td>
</tr>
<tr>
<td>rpc_zmq_bind_address = *</td>
<td>(StrOpt) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The "host" option should point or resolve to this address.</td>
</tr>
<tr>
<td>rpc_zmq_contexts = 1</td>
<td>(IntOpt) Number of ZeroMQ contexts, defaults to 1</td>
</tr>
<tr>
<td>rpc_zmq_host = oslo</td>
<td>(StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova.</td>
</tr>
<tr>
<td>rpc_zmq_ipc_dir = /var/run/openstack</td>
<td>(StrOpt) Directory for holding IPC sockets</td>
</tr>
<tr>
<td>rpc_zmq_matchmaker = ceilometer.openstack.common.rpc.matchmaker.MatchMakerLocalhost</td>
<td>(StrOpt) MatchMaker driver</td>
</tr>
<tr>
<td>rpc_zmq_port = 9501</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>
<th colspan="2">[publisher]</th>
</tr>
<tr>
<td>metering_secret = change this or be hacked</td>
<td>(StrOpt) Secret value for signing metering messages.</td>
</tr>
<tr>
<th colspan="2">[publisher_rpc]</th>
</tr>
<tr>
<td>metering_topic = metering</td>
<td>(StrOpt) The topic that ceilometer uses for metering messages.</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>

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 ssl</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">[ssl]</th>
</tr>
<tr>
<td>ca_file = None</td>
<td>(StrOpt) CA certificate file to use to verify connecting clients</td>
</tr>
<tr>
<td>cert_file = None</td>
<td>(StrOpt) Certificate file to use when starting the server securely</td>
</tr>
<tr>
<td>key_file = None</td>
<td>(StrOpt) Private key file to use when starting the server securely</td>
</tr>
</tbody>
</table>
</para>

View File

@ -0,0 +1,27 @@
<?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 swift</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>reseller_prefix = AUTH_</td>
<td>(StrOpt) Swift reseller prefix. Must be on par with reseller_prefix in proxy-server.conf.</td>
</tr>
</tbody>
</table>
</para>

View File

@ -1,92 +1,55 @@
admin_password keystone_authtoken
admin_tenant_name keystone_authtoken
admin_token keystone_authtoken
admin_user keystone_authtoken
allowed_rpc_exception_modules
auth_admin_prefix
auth_host keystone_authtoken
auth_port keystone_authtoken
auth_protocol keystone_authtoken
auth_strategy DEFAULT
auth_uri keystone_authtoken
auth_version keystone_authtoken
backdoor_port DEFAULT
backend database
cache
certfile keystone_authtoken
cinder_control_exchange DEFAULT
connection database
connection_debug database
connection_trace database
control_exchange DEFAULT
counter_source DEFAULT
database_connection DEFAULT
allowed_rpc_exception_modules rpc
amqp_auto_delete amqp
amqp_durable_queues amqp
auth_strategy auth
backdoor_port common
cinder_control_exchange exchange
control_exchange exchange
database_connection database
debug logging
default_log_levels logging
default_notification_level logging
default_publisher_id DEFAULT
delay_auth_decision
disable_process_locking
enable_v1_api DEFAULT
fake_rabbit
fatal_deprecations
glance_control_exchange DEFAULT
host
host
host
http_connect_timeout
http_handler
hypervisor_inspector
idle_timeout
instance_format
instance_uuid_format
keyfile keystone_authtoken
kombu_ssl_ca_certs
kombu_ssl_certfile
kombu_ssl_keyfile
kombu_ssl_version
libvirt_type
libvirt_uri
list_notifier_drivers
lock_path
log_config logging
log_date_format logging
log_dir logging
log_file logging
log_format logging
default_publisher_id exchange
disable_process_locking common
dispatcher rpc
enable_v1_api api
fake_rabbit rabbitmq
fatal_deprecations common
glance_control_exchange exchange
heat_control_exchange exchange
host redis
http_control_exchanges exchange
hypervisor_inspector inspector
instance_format logging
instance_uuid_format logging
kombu_ssl_ca_certs rabbitmq
kombu_ssl_certfile rabbitmq
kombu_ssl_keyfile rabbitmq
kombu_ssl_version rabbitmq
libvirt_type inspector
libvirt_uri inspector
lock_path common
log-config-append logging
log-date-format logging
log-dir logging
log-file logging
log-format logging
logging_context_format_string logging
logging_debug_format_suffix logging
logging_default_format_string logging
logging_exception_prefix logging
matchmaker_heartbeat_freq
matchmaker_heartbeat_ttl
max_overflow
max_pool_size
max_retries
memcache_secret_key
memcache_security_strategy
memcache_servers
memcached_servers
metering_secret DEFAULT
metering_topic DEFAULT
min_pool_size database
matchmaker_heartbeat_freq redis
matchmaker_heartbeat_ttl redis
max_request_body_size api
mysql_engine database
notification_driver
notification_topics
nova_control_exchange DEFAULT
os_auth_url service_credentials
os_password service_credentials
os_tenant_id service_credentials
os_tenant_name service_credentials
os_username service_credentials
password
pipeline_cfg_file
policy_default_rule
policy_file
pool_timeout
port
port
publish_errors
neutron_control_exchange exchange
notification_driver amqp
notification_topics amqp
nova_control_exchange exchange
pipeline_cfg_file api
policy_default_rule api
policy_file api
publish_errors logging
qpid_heartbeat qpid
qpid_hostname qpid
qpid_hosts qpid
@ -95,9 +58,8 @@ qpid_port qpid
qpid_protocol qpid
qpid_sasl_mechanisms qpid
qpid_tcp_nodelay qpid
qpid_topology_version qpid
qpid_username qpid
quantum_control_exchange DEFAULT
rabbit_durable_queues rabbitmq
rabbit_ha_queues rabbitmq
rabbit_host rabbitmq
rabbit_hosts rabbitmq
@ -109,12 +71,9 @@ rabbit_retry_interval rabbitmq
rabbit_use_ssl rabbitmq
rabbit_userid rabbitmq
rabbit_virtual_host rabbitmq
reseller_prefix DEFAULT
reserved_metadata_length
reserved_metadata_namespace
retry_interval
revocation_cache_time
ringfile
reseller_prefix swift
reserved_metadata_length api
reserved_metadata_namespace api
rpc_backend rpc
rpc_cast_timeout rpc
rpc_conn_pool_size rpc
@ -127,16 +86,62 @@ rpc_zmq_ipc_dir rpc
rpc_zmq_matchmaker rpc
rpc_zmq_port rpc
rpc_zmq_topic_backlog rpc
signing_dir keystone_authtoken
slave_connection
sample_source exchange
sqlite_db database
sqlite_synchronous database
syslog_log_facility
token_cache_time
topics
udp_address
udp_port
use_stderr
use_syslog
use_tpool database
syslog-log-facility logging
use-syslog logging
use-syslog-rfc-format logging
use_stderr logging
verbose logging
alarm/evaluation_interval alarm
alarm/evaluation_service alarm
alarm/notifier_rpc_topic alarm
alarm/partition_rpc_topic alarm
alarm/record_history alarm
alarm/rest_notifier_certificate_file alarm
alarm/rest_notifier_certificate_key alarm
alarm/rest_notifier_ssl_verify alarm
api/host api
api/port api
collector/udp_address collector
collector/udp_port collector
database/backend database
database/connection database
database/connection_debug database
database/connection_trace database
database/idle_timeout database
database/max_overflow database
database/max_pool_size database
database/max_retries database
database/min_pool_size database
database/pool_timeout database
database/retry_interval database
database/slave_connection database
database/time_to_live database
dispatcher_file/backup_count collector
dispatcher_file/file_path collector
dispatcher_file/max_bytes collector
event/definitions_cfg_file events
event/drop_unmatched_notifications events
matchmaker_redis/host redis
matchmaker_redis/password redis
matchmaker_redis/port redis
matchmaker_ring/ringfile redis
notification/ack_on_event_error events
notification/store_events events
publisher/metering_secret rpc
publisher_rpc/metering_topic rpc
rpc_notifier2/topics rpc
service_credentials/insecure auth
service_credentials/os-auth-url auth
service_credentials/os-cacert auth
service_credentials/os-endpoint-type auth
service_credentials/os-password auth
service_credentials/os-region-name auth
service_credentials/os-tenant-id auth
service_credentials/os-tenant-name auth
service_credentials/os-username auth
ssl/ca_file ssl
ssl/cert_file ssl
ssl/key_file ssl