diff --git a/doc/common/tables/ceilometer-alarms.xml b/doc/common/tables/ceilometer-alarms.xml new file mode 100644 index 0000000000..00fb4ef0a9 --- /dev/null +++ b/doc/common/tables/ceilometer-alarms.xml @@ -0,0 +1,26 @@ + + + + + + + + + + + + + + + + + + + + + + +
Description of alarms configuration options
Configuration option = Default valueDescription
[alarms]
= http://localhost:8041(StrOpt) URL to Gnocchi.
+
diff --git a/doc/common/tables/ceilometer-amqp.xml b/doc/common/tables/ceilometer-amqp.xml index ba92bb6c31..c3ea737f58 100644 --- a/doc/common/tables/ceilometer-amqp.xml +++ b/doc/common/tables/ceilometer-amqp.xml @@ -17,14 +17,6 @@ [DEFAULT] - - = False - (BoolOpt) Auto-delete queues in AMQP. - - - = False - (BoolOpt) Use durable queues in AMQP. - = openstack (StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. diff --git a/doc/common/tables/ceilometer-api.xml b/doc/common/tables/ceilometer-api.xml index 84cf40ad62..e87a9330f5 100644 --- a/doc/common/tables/ceilometer-api.xml +++ b/doc/common/tables/ceilometer-api.xml @@ -21,6 +21,10 @@ = api_paste.ini (StrOpt) Configuration file for WSGI definition of API. + + = 1 + (IntOpt) Number of workers for Ceilometer API server. + = event_pipeline.yaml (StrOpt) Configuration file for event pipeline definition. @@ -29,18 +33,6 @@ = pipeline.yaml (StrOpt) Configuration file for pipeline definition. - - = default - (StrOpt) Default rule. Enforced when a requested rule is not found. - - - = ['policy.d'] - (MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched. - - - = policy.json - (StrOpt) The JSON file that defines policies. - = (ListOpt) List of metadata keys reserved for metering use. And these keys are additional to the ones included in the namespace. @@ -56,17 +48,13 @@ [api] - - = False - (BoolOpt) Set it to False if your environment does not need or have a DNS server, otherwise it will delay the response from the API. - = 0.0.0.0 (StrOpt) The listen IP for the ceilometer API server. - = None - (BoolOpt) Toggle Pecan Debug Middleware. If it is not set, global debug value will be used. + = False + (BoolOpt) Toggle Pecan Debug Middleware. = 8777 diff --git a/doc/common/tables/ceilometer-common.xml b/doc/common/tables/ceilometer-common.xml index 7b863de120..32eddf6772 100644 --- a/doc/common/tables/ceilometer-common.xml +++ b/doc/common/tables/ceilometer-common.xml @@ -49,6 +49,10 @@ = 0 (IntOpt) To reduce large requests at same time to Nova or other components from different compute agents, shuffle start time of polling task. + + = False + (BoolOpt) Indicates if expirer expires only samples. If set true, expired samples will be deleted, but residual resource and meter definition data will remain. + [compute] diff --git a/doc/common/tables/ceilometer-database.xml b/doc/common/tables/ceilometer-database.xml index 75a504ffe9..2cd5cbbd12 100644 --- a/doc/common/tables/ceilometer-database.xml +++ b/doc/common/tables/ceilometer-database.xml @@ -50,19 +50,19 @@ = True - (BoolOpt) If True, increases the interval between database connection retries up to db_max_retry_interval. + (BoolOpt) If True, increases the interval between retries of a database operation up to db_max_retry_interval. = 20 - (IntOpt) Maximum database connection retries before error is raised. Set to -1 to specify an infinite retry count. + (IntOpt) Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count. = 10 - (IntOpt) If db_inc_retry_interval is set, the maximum seconds between database connection retries. + (IntOpt) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation. = 1 - (IntOpt) Seconds between database connection retries. + (IntOpt) Seconds between retries of a database transaction. = None diff --git a/doc/common/tables/ceilometer-dispatcher_http.xml b/doc/common/tables/ceilometer-dispatcher_http.xml index bb44bdb848..e5b178c71b 100644 --- a/doc/common/tables/ceilometer-dispatcher_http.xml +++ b/doc/common/tables/ceilometer-dispatcher_http.xml @@ -19,15 +19,19 @@ = False - (BoolOpt) The flag which indicates if only cadf message should be posted. If false, all meters will be posted. + (BoolOpt) The flag that indicates if only cadf message should be posted. If false, all meters will be posted. + + + = None + (StrOpt) The target for event data where the http request will be sent to. If this is not set, it will default to same as Sample target. = - (StrOpt) The target where the http request will be sent to. If this is not set, no data will be posted. For example: target = http://hostname:1234/path + (StrOpt) The target where the http request will be sent. If this is not set, no data will be posted. For example: target = http://hostname:1234/path = 5 - (IntOpt) The max time in second to wait for a request to timeout. + (IntOpt) The max time in seconds to wait for a request to timeout. diff --git a/doc/common/tables/ceilometer-events.xml b/doc/common/tables/ceilometer-events.xml index 3a2da68c8c..7b5fa1083e 100644 --- a/doc/common/tables/ceilometer-events.xml +++ b/doc/common/tables/ceilometer-events.xml @@ -25,6 +25,10 @@ = False (BoolOpt) Drop notifications if no event definition matches. (Otherwise, we convert them with just the default traits) + + = [] + (MultiStrOpt) Store the raw notification for select priority levels (info and/or error). By default, raw details are not captured. + [notification] diff --git a/doc/common/tables/ceilometer-inspector.xml b/doc/common/tables/ceilometer-inspector.xml index b5ca3a7af3..3307e390a5 100644 --- a/doc/common/tables/ceilometer-inspector.xml +++ b/doc/common/tables/ceilometer-inspector.xml @@ -23,7 +23,7 @@ = kvm - (StrOpt) Libvirt domain type (valid options are: kvm, lxc, qemu, uml, xen). + (StrOpt) Libvirt domain type. = diff --git a/doc/common/tables/ceilometer-ipmi.xml b/doc/common/tables/ceilometer-ipmi.xml index 3f72d84874..63536fa6ac 100644 --- a/doc/common/tables/ceilometer-ipmi.xml +++ b/doc/common/tables/ceilometer-ipmi.xml @@ -21,6 +21,10 @@ = 3 (IntOpt) Number of retries upon Intel Node Manager initialization failure + + = 3 + (IntOpt) Tolerance of IPMI/NM polling failures before disable this pollster. Negative indicates retrying forever. + diff --git a/doc/common/tables/ceilometer-notification.xml b/doc/common/tables/ceilometer-notification.xml new file mode 100644 index 0000000000..c94f47db41 --- /dev/null +++ b/doc/common/tables/ceilometer-notification.xml @@ -0,0 +1,26 @@ + + + + + + + + + + + + + + + + + + + + + + +
Description of notification configuration options
Configuration option = Default valueDescription
[notification]
= False(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. This option disables the collection of non-metric meters and will be the default behavior in Liberty.
+
diff --git a/doc/common/tables/ceilometer-qpid.xml b/doc/common/tables/ceilometer-qpid.xml index e833cbde67..b272640f09 100644 --- a/doc/common/tables/ceilometer-qpid.xml +++ b/doc/common/tables/ceilometer-qpid.xml @@ -15,7 +15,15 @@ - [DEFAULT] + [oslo_messaging_qpid] + + + = False + (BoolOpt) Auto-delete queues in AMQP. + + + = False + (BoolOpt) Use durable queues in AMQP. = 60 @@ -61,6 +69,10 @@ = (StrOpt) Username for Qpid connection. + + = 30 + (IntOpt) Size of RPC connection pool. + diff --git a/doc/common/tables/ceilometer-rabbitmq.xml b/doc/common/tables/ceilometer-rabbitmq.xml index c0dd5d66f8..565a38de2f 100644 --- a/doc/common/tables/ceilometer-rabbitmq.xml +++ b/doc/common/tables/ceilometer-rabbitmq.xml @@ -15,7 +15,27 @@ - [DEFAULT] + [oslo_messaging_rabbit] + + + = False + (BoolOpt) Auto-delete queues in AMQP. + + + = False + (BoolOpt) Use durable queues in AMQP. + + + = False + (BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake + + + = 2 + (IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat. + + + = 60 + (IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disable the heartbeat). = 1.0 @@ -85,6 +105,10 @@ = / (StrOpt) The RabbitMQ virtual host. + + = 30 + (IntOpt) Size of RPC connection pool. + diff --git a/doc/common/tables/ceilometer-rpc.xml b/doc/common/tables/ceilometer-rpc.xml index d458d8361d..0cf5dd229d 100644 --- a/doc/common/tables/ceilometer-rpc.xml +++ b/doc/common/tables/ceilometer-rpc.xml @@ -37,10 +37,6 @@ = 30 (IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq. - - = 30 - (IntOpt) Size of RPC connection pool. - = 60 (IntOpt) Seconds to wait for a response from a call. @@ -107,8 +103,8 @@ [publisher] - = change this or be hacked - (StrOpt) Secret value for signing metering messages. + = change this for valid signing + (StrOpt) Secret value for signing messages. Set value empty if signing is not required to avoid computational overhead. [publisher_notifier] diff --git a/tools/autogenerate-config-flagmappings/ceilometer.flagmappings b/tools/autogenerate-config-flagmappings/ceilometer.flagmappings index 5a31cac8e7..bdb487ca4a 100644 --- a/tools/autogenerate-config-flagmappings/ceilometer.flagmappings +++ b/tools/autogenerate-config-flagmappings/ceilometer.flagmappings @@ -1,6 +1,5 @@ -amqp_auto_delete amqp -amqp_durable_queues amqp api_paste_config api +api_workers api backdoor_port debug cinder_control_exchange exchange collector_workers collector @@ -10,7 +9,6 @@ debug logging default_log_levels logging dispatcher rpc event_pipeline_cfg_file api -fake_rabbit testing fatal_deprecations logging glance_control_exchange exchange glance_page_size glance @@ -23,11 +21,6 @@ instance_format logging instance_uuid_format logging ironic_exchange exchange keystone_control_exchange exchange -kombu_reconnect_delay rabbitmq -kombu_ssl_ca_certs rabbitmq -kombu_ssl_certfile rabbitmq -kombu_ssl_keyfile rabbitmq -kombu_ssl_version rabbitmq libvirt_type inspector libvirt_uri inspector log_config_append logging @@ -50,35 +43,9 @@ notification_workers common nova_control_exchange exchange nova_http_log_debug debug pipeline_cfg_file api -policy_default_rule api -policy_dirs api -policy_file api polling_namespaces common pollster_list common publish_errors logging -qpid_heartbeat qpid -qpid_hostname qpid -qpid_hosts qpid -qpid_password qpid -qpid_port qpid -qpid_protocol qpid -qpid_receiver_capacity qpid -qpid_sasl_mechanisms qpid -qpid_tcp_nodelay qpid -qpid_topology_version qpid -qpid_username qpid -rabbit_ha_queues rabbitmq -rabbit_host rabbitmq -rabbit_hosts rabbitmq -rabbit_login_method rabbitmq -rabbit_max_retries rabbitmq -rabbit_password rabbitmq -rabbit_port rabbitmq -rabbit_retry_backoff rabbitmq -rabbit_retry_interval rabbitmq -rabbit_use_ssl rabbitmq -rabbit_userid rabbitmq -rabbit_virtual_host rabbitmq reseller_prefix swift reserved_metadata_keys api reserved_metadata_length api @@ -86,7 +53,6 @@ reserved_metadata_namespace api rootwrap_config common rpc_backend rpc rpc_cast_timeout rpc -rpc_conn_pool_size rpc rpc_response_timeout rpc rpc_thread_pool_size rpc rpc_zmq_bind_address zeromq @@ -99,6 +65,7 @@ rpc_zmq_topic_backlog zeromq sahara_control_exchange exchange sample_source exchange shuffle_time_before_polling_task common +sql_expire_samples_only common swift_control_exchange exchange syslog_log_facility logging transport_url amqp @@ -119,7 +86,7 @@ alarm/rest_notifier_certificate_key alarm alarm/rest_notifier_max_retries alarm alarm/rest_notifier_ssl_verify alarm alarm/user_alarm_quota alarm -api/enable_reverse_dns_lookup api +alarms/gnocchi_url alarms api/host api api/pecan_debug api api/port api @@ -162,14 +129,17 @@ dispatcher_file/backup_count collector dispatcher_file/file_path collector dispatcher_file/max_bytes collector dispatcher_http/cadf_only dispatcher_http +dispatcher_http/event_target dispatcher_http dispatcher_http/target dispatcher_http dispatcher_http/timeout dispatcher_http event/definitions_cfg_file events event/drop_unmatched_notifications events +event/store_raw events hardware/readonly_user_name tripleo hardware/readonly_user_password tripleo hardware/url_scheme tripleo ipmi/node_manager_init_retry ipmi +ipmi/polling_retry ipmi keystone_authtoken/admin_password auth_token keystone_authtoken/admin_tenant_name auth_token keystone_authtoken/admin_token auth_token @@ -212,6 +182,7 @@ matchmaker_redis/password redis matchmaker_redis/port redis matchmaker_ring/ringfile redis notification/ack_on_event_error events +notification/disable_non_metric_meters notification notification/messaging_urls rpc notification/store_events events notification/workload_partitioning events @@ -228,6 +199,43 @@ oslo_messaging_amqp/ssl_cert_file rpc oslo_messaging_amqp/ssl_key_file rpc oslo_messaging_amqp/ssl_key_password rpc oslo_messaging_amqp/trace rpc +oslo_messaging_qpid/amqp_auto_delete qpid +oslo_messaging_qpid/amqp_durable_queues qpid +oslo_messaging_qpid/qpid_heartbeat qpid +oslo_messaging_qpid/qpid_hostname qpid +oslo_messaging_qpid/qpid_hosts qpid +oslo_messaging_qpid/qpid_password qpid +oslo_messaging_qpid/qpid_port qpid +oslo_messaging_qpid/qpid_protocol qpid +oslo_messaging_qpid/qpid_receiver_capacity qpid +oslo_messaging_qpid/qpid_sasl_mechanisms qpid +oslo_messaging_qpid/qpid_tcp_nodelay qpid +oslo_messaging_qpid/qpid_topology_version qpid +oslo_messaging_qpid/qpid_username qpid +oslo_messaging_qpid/rpc_conn_pool_size qpid +oslo_messaging_rabbit/amqp_auto_delete rabbitmq +oslo_messaging_rabbit/amqp_durable_queues rabbitmq +oslo_messaging_rabbit/fake_rabbit rabbitmq +oslo_messaging_rabbit/heartbeat_rate rabbitmq +oslo_messaging_rabbit/heartbeat_timeout_threshold rabbitmq +oslo_messaging_rabbit/kombu_reconnect_delay rabbitmq +oslo_messaging_rabbit/kombu_ssl_ca_certs rabbitmq +oslo_messaging_rabbit/kombu_ssl_certfile rabbitmq +oslo_messaging_rabbit/kombu_ssl_keyfile rabbitmq +oslo_messaging_rabbit/kombu_ssl_version rabbitmq +oslo_messaging_rabbit/rabbit_ha_queues rabbitmq +oslo_messaging_rabbit/rabbit_host rabbitmq +oslo_messaging_rabbit/rabbit_hosts rabbitmq +oslo_messaging_rabbit/rabbit_login_method rabbitmq +oslo_messaging_rabbit/rabbit_max_retries rabbitmq +oslo_messaging_rabbit/rabbit_password rabbitmq +oslo_messaging_rabbit/rabbit_port rabbitmq +oslo_messaging_rabbit/rabbit_retry_backoff rabbitmq +oslo_messaging_rabbit/rabbit_retry_interval rabbitmq +oslo_messaging_rabbit/rabbit_use_ssl rabbitmq +oslo_messaging_rabbit/rabbit_userid rabbitmq +oslo_messaging_rabbit/rabbit_virtual_host rabbitmq +oslo_messaging_rabbit/rpc_conn_pool_size rabbitmq polling/partitioning_group_prefix common publisher/telemetry_secret rpc publisher_notifier/event_topic rpc diff --git a/tools/autogenerate-config-flagmappings/ceilometer.headers b/tools/autogenerate-config-flagmappings/ceilometer.headers index 6ef7164b4a..32fccf8bd9 100644 --- a/tools/autogenerate-config-flagmappings/ceilometer.headers +++ b/tools/autogenerate-config-flagmappings/ceilometer.headers @@ -1,9 +1,11 @@ alarm alarm +alarms alarms collector collector dispatcher_http HTTP dispatcher events events exchange exchange inspector inspector magnetodb MagnetoDB +notification notification service_types service types zaqar Zaqar