Ceilometer Config Ref update

Change-Id: I4fb8ebf4af52fdece4dc0ba534484bc70aef1e6e
This commit is contained in:
Ildiko Vancsa 2015-10-08 10:24:01 +02:00
parent 7530a1a78d
commit 5c1000ae37
9 changed files with 72 additions and 14 deletions

View File

@ -33,6 +33,10 @@
<td><option>pipeline_polling_interval</option> = <replaceable>20</replaceable></td>
<td>(IntOpt) Polling interval for pipeline file configuration in seconds.</td>
</tr>
<tr>
<td><option>refresh_event_pipeline_cfg</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Refresh Event Pipeline configuration on-the-fly.</td>
</tr>
<tr>
<td><option>refresh_pipeline_cfg</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Refresh Pipeline configuration on-the-fly.</td>

View File

@ -149,6 +149,10 @@
<td><option>memcache_use_advanced_pool</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x.</td>
</tr>
<tr>
<td><option>region_name</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The region in which the identity server can be found.</td>
</tr>
<tr>
<td><option>revocation_cache_time</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance.</td>

View File

@ -104,10 +104,6 @@
<td><option>min_pool_size</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Minimum number of SQL connections to keep open in a pool.</td>
</tr>
<tr>
<td><option>mongodb_replica_set</option> = <replaceable></replaceable></td>
<td>(StrOpt) The name of the replica set which is used to connect to MongoDB database. Add "?replicaSet=myreplicatset" in your connection URI instead.</td>
</tr>
<tr>
<td><option>mysql_sql_mode</option> = <replaceable>TRADITIONAL</replaceable></td>
<td>(StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=</td>

View File

@ -21,10 +21,6 @@
<td><option>archive_policy</option> = <replaceable>low</replaceable></td>
<td>(StrOpt) The archive policy to use when the dispatcher create a new metric.</td>
</tr>
<tr>
<td><option>archive_policy_file</option> = <replaceable>gnocchi_archive_policy_map.yaml</replaceable></td>
<td>(StrOpt) The Yaml file that defines per metric archive policies.</td>
</tr>
<tr>
<td><option>filter_project</option> = <replaceable>gnocchi</replaceable></td>
<td>(StrOpt) Gnocchi project used to filter out samples generated by Gnocchi service activity</td>

View File

@ -19,7 +19,7 @@
</tr>
<tr>
<td><option>cadf_only</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) The flag that indicates if only cadf message should be posted. If false, all meters will be posted.</td>
<td>(BoolOpt) The flag that indicates if only cadf message should be posted. If false, all meters will be posted. This is deprecated in favor of keystonemiddleware's audit middleware functionality</td>
</tr>
<tr>
<td><option>event_target</option> = <replaceable>None</replaceable></td>

View File

@ -21,6 +21,10 @@
<td><option>disable_non_metric_meters</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) WARNING: Ceilometer historically offered the ability to store events as meters. This usage is NOT advised as it can flood the metering database and cause performance degradation.</td>
</tr>
<tr>
<td><option>pipeline_processing_queues</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) Number of queues to parallelize workload across. This value should be larger than the number of active notification agents for optimal results.</td>
</tr>
</tbody>
</table>
</para>

View File

@ -17,6 +17,10 @@
<tr>
<th colspan="2">[hardware]</th>
</tr>
<tr>
<td><option>meter_definitions_file</option> = <replaceable>snmp.yaml</replaceable></td>
<td>(StrOpt) Configuration file for defining hardware snmp meters.</td>
</tr>
<tr>
<td><option>readonly_user_name</option> = <replaceable>ro_snmp_user</replaceable></td>
<td>(StrOpt) SNMPd user name of all nodes running in the cloud.</td>

View File

@ -1,7 +1,7 @@
<?xml version='1.0' encoding='UTF-8'?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="ceilometer-conf-changes-liberty">
<!-- Warning: Do not edit this file. It is automatically generated and your changes will be overwritten. The tool to do so lives in the openstack-doc-tools repository. -->
<title>New, updated and deprecated options in Liberty for Telemetry</title>
<title>New, updated, and deprecated options in Liberty for Telemetry</title>
<table>
<caption>New options</caption>
<col width="50%"/>
@ -28,10 +28,18 @@
<td>[DEFAULT] executor_thread_pool_size = 64</td>
<td>(IntOpt) Size of executor thread pool.</td>
</tr>
<tr>
<td>[DEFAULT] magnum_control_exchange = magnum</td>
<td>(StrOpt) Exchange name for Magnum notifications.</td>
</tr>
<tr>
<td>[DEFAULT] pipeline_polling_interval = 20</td>
<td>(IntOpt) Polling interval for pipeline file configuration in seconds.</td>
</tr>
<tr>
<td>[DEFAULT] refresh_event_pipeline_cfg = False</td>
<td>(BoolOpt) Refresh Event Pipeline configuration on-the-fly.</td>
</tr>
<tr>
<td>[DEFAULT] refresh_pipeline_cfg = False</td>
<td>(BoolOpt) Refresh Pipeline configuration on-the-fly.</td>
@ -60,6 +68,18 @@
<td>[api] gnocchi_is_enabled = None</td>
<td>(BoolOpt) Set True to disable resource/meter/sample URLs. Default autodetection by querying keystone.</td>
</tr>
<tr>
<td>[api] workers = 1</td>
<td>(IntOpt) Number of workers for api, default value is 1.</td>
</tr>
<tr>
<td>[collector] enable_rpc = False</td>
<td>(BoolOpt) Enable the RPC functionality of collector. This functionality is now deprecated in favour of notifier publisher and queues.</td>
</tr>
<tr>
<td>[collector] workers = 1</td>
<td>(IntOpt) Number of workers for collector service. default value is 1.</td>
</tr>
<tr>
<td>[cors] allow_credentials = True</td>
<td>(BoolOpt) Indicate that the actual request can include user credentials</td>
@ -136,13 +156,29 @@
<td>[dispatcher_gnocchi] url = http://localhost:8041</td>
<td>(StrOpt) URL to Gnocchi.</td>
</tr>
<tr>
<td>[hardware] meter_definitions_file = snmp.yaml</td>
<td>(StrOpt) Configuration file for defining hardware snmp meters.</td>
</tr>
<tr>
<td>[keystone_authtoken] region_name = None</td>
<td>(StrOpt) The region in which the identity server can be found.</td>
</tr>
<tr>
<td>[meter] meter_definitions_cfg_file = meters.yaml</td>
<td>(StrOpt) Configuration file for defining meter notifications.</td>
</tr>
<tr>
<td>[notification] pipeline_processing_queues = 10</td>
<td>(IntOpt) Number of queues to parallelize workload across. This value should be larger than the number of active notification agents for optimal results.</td>
</tr>
<tr>
<td>[notification] workers = 1</td>
<td>(IntOpt) Number of workers for notification service, default value is 1.</td>
</tr>
<tr>
<td>[oslo_messaging_qpid] send_single_reply = False</td>
<td>(BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in M release.</td>
<td>(BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release.</td>
</tr>
<tr>
<td>[oslo_messaging_rabbit] kombu_reconnect_timeout = 60</td>
@ -150,7 +186,7 @@
</tr>
<tr>
<td>[oslo_messaging_rabbit] send_single_reply = False</td>
<td>(BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in M release.</td>
<td>(BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release.</td>
</tr>
<tr>
<td>[oslo_middleware] secure_proxy_ssl_header = X-Forwarded-Proto</td>
@ -218,10 +254,22 @@
<td>New Option</td>
</tr>
</thead>
<tr>
<td>[DEFAULT] api_workers</td>
<td>[api] workers</td>
</tr>
<tr>
<td>[DEFAULT] notification_workers</td>
<td>[notification] workers</td>
</tr>
<tr>
<td>[DEFAULT] database_connection</td>
<td>None</td>
</tr>
<tr>
<td>[DEFAULT] collector_workers</td>
<td>[collector] workers</td>
</tr>
<tr>
<td>[DEFAULT] rpc_thread_pool_size</td>
<td>[DEFAULT] executor_thread_pool_size</td>

View File

@ -48,6 +48,7 @@ pipeline_polling_interval api
polling_namespaces common
pollster_list common
publish_errors logging
refresh_event_pipeline_cfg api
refresh_pipeline_cfg api
reseller_prefix swift
reserved_metadata_keys api
@ -139,7 +140,6 @@ database/max_retries database
database/metering_connection database
database/metering_time_to_live database
database/min_pool_size database
database/mongodb_replica_set database
database/mysql_sql_mode database
database/pool_timeout database
database/retry_interval database
@ -151,7 +151,6 @@ dispatcher_file/backup_count collector
dispatcher_file/file_path collector
dispatcher_file/max_bytes collector
dispatcher_gnocchi/archive_policy dispatcher_gnocchi
dispatcher_gnocchi/archive_policy_file dispatcher_gnocchi
dispatcher_gnocchi/filter_project dispatcher_gnocchi
dispatcher_gnocchi/filter_service_activity dispatcher_gnocchi
dispatcher_gnocchi/resources_definition_file dispatcher_gnocchi
@ -163,6 +162,7 @@ dispatcher_http/timeout dispatcher_http
event/definitions_cfg_file events
event/drop_unmatched_notifications events
event/store_raw events
hardware/meter_definitions_file tripleo
hardware/readonly_user_name tripleo
hardware/readonly_user_password tripleo
hardware/url_scheme tripleo
@ -202,6 +202,7 @@ keystone_authtoken/memcache_secret_key auth_token
keystone_authtoken/memcache_security_strategy auth_token
keystone_authtoken/memcache_use_advanced_pool auth_token
keystone_authtoken/memcached_servers common
keystone_authtoken/region_name auth_token
keystone_authtoken/revocation_cache_time auth_token
keystone_authtoken/signing_dir auth_token
keystone_authtoken/token_cache_time auth_token
@ -213,6 +214,7 @@ meter/meter_definitions_cfg_file common
notification/ack_on_event_error events
notification/disable_non_metric_meters notification
notification/messaging_urls rpc
notification/pipeline_processing_queues notification
notification/store_events events
notification/workers events
notification/workload_partitioning events