63 lines
3.0 KiB
ReStructuredText
63 lines
3.0 KiB
ReStructuredText
..
|
|
Warning: Do not edit this file. It is automatically generated from the
|
|
software project's code and your changes will be overwritten.
|
|
|
|
The tool to generate this file lives in openstack-doc-tools repository.
|
|
|
|
Please make any changes needed in the code, then run the
|
|
autogenerate-config-doc tool from the openstack-doc-tools repository, or
|
|
ask for help on the documentation mailing list, IRC channel or meeting.
|
|
|
|
.. _ceilometer-api:
|
|
|
|
.. list-table:: Description of API configuration options
|
|
:header-rows: 1
|
|
:class: config-ref-table
|
|
|
|
* - Configuration option = Default value
|
|
- Description
|
|
* - **[DEFAULT]**
|
|
-
|
|
* - ``api_paste_config`` = ``api_paste.ini``
|
|
- (String) Configuration file for WSGI definition of API.
|
|
* - ``event_pipeline_cfg_file`` = ``event_pipeline.yaml``
|
|
- (String) Configuration file for event pipeline definition.
|
|
* - ``pipeline_cfg_file`` = ``pipeline.yaml``
|
|
- (String) Configuration file for pipeline definition.
|
|
* - ``pipeline_polling_interval`` = ``20``
|
|
- (Integer) Polling interval for pipeline file configuration in seconds.
|
|
* - ``refresh_event_pipeline_cfg`` = ``False``
|
|
- (Boolean) Refresh Event Pipeline configuration on-the-fly.
|
|
* - ``refresh_pipeline_cfg`` = ``False``
|
|
- (Boolean) Refresh Pipeline configuration on-the-fly.
|
|
* - ``reserved_metadata_keys`` =
|
|
- (List) List of metadata keys reserved for metering use. And these keys are additional to the ones included in the namespace.
|
|
* - ``reserved_metadata_length`` = ``256``
|
|
- (Integer) Limit on length of reserved metadata values.
|
|
* - ``reserved_metadata_namespace`` = ``metering.``
|
|
- (List) List of metadata prefixes reserved for metering use.
|
|
* - **[api]**
|
|
-
|
|
* - ``aodh_is_enabled`` = ``None``
|
|
- (Boolean) Set True to redirect alarms URLs to aodh. Default autodetection by querying keystone.
|
|
* - ``aodh_url`` = ``None``
|
|
- (String) The endpoint of Aodh to redirect alarms URLs to Aodh API. Default autodetection by querying keystone.
|
|
* - ``default_api_return_limit`` = ``100``
|
|
- (Integer) Default maximum number of items returned by API request.
|
|
* - ``gnocchi_is_enabled`` = ``None``
|
|
- (Boolean) Set True to disable resource/meter/sample URLs. Default autodetection by querying keystone.
|
|
* - ``host`` = ``0.0.0.0``
|
|
- (String) The listen IP for the ceilometer API server.
|
|
* - ``pecan_debug`` = ``False``
|
|
- (Boolean) Toggle Pecan Debug Middleware.
|
|
* - ``port`` = ``8777``
|
|
- (Unknown) The port for the ceilometer API server.
|
|
* - ``workers`` = ``1``
|
|
- (Integer) Number of workers for api, default value is 1.
|
|
* - **[oslo_middleware]**
|
|
-
|
|
* - ``max_request_body_size`` = ``114688``
|
|
- (Integer) The maximum body size for each request, in bytes.
|
|
* - ``secure_proxy_ssl_header`` = ``X-Forwarded-Proto``
|
|
- (String) DEPRECATED: The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by an SSL termination proxy.
|