Telemetry configuration options¶
The following tables provide a comprehensive list of the Telemetry configuration options.
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| control_exchange = openstack | (String) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option. |
| transport_url = None | (String) 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. |
| 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 | (Port number) 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. |
| Configuration option = Default value | Description |
|---|---|
| [service_credentials] | |
| auth_section = None | (Unknown) Config Section from which to load plugin specific options |
| auth_type = None | (Unknown) Authentication type to load |
| cafile = None | (String) PEM encoded Certificate Authority to use when verifying HTTPs connections. |
| certfile = None | (String) PEM encoded client certificate cert file |
| insecure = False | (Boolean) Verify HTTPS connections. |
| interface = public | (String) Type of endpoint in Identity service catalog to use for communication with OpenStack services. |
| keyfile = None | (String) PEM encoded client certificate key file |
| region_name = None | (String) Region name to use for OpenStack service endpoints. |
| timeout = None | (Integer) Timeout value for http requests |
| Configuration option = Default value | Description |
|---|---|
| [keystone_authtoken] | |
| admin_password = None | (String) Service user password. |
| admin_tenant_name = admin | (String) Service tenant name. |
| admin_token = None | (String) This option is deprecated and may be removed in a future release. Single shared secret with the Keystone configuration used for bootstrapping a Keystone installation, or otherwise bypassing the normal authentication process. This option should not be used, use admin_user and admin_password instead. |
| admin_user = None | (String) Service username. |
| auth_admin_prefix = | (String) Prefix to prepend at the beginning of the path. Deprecated, use identity_uri. |
| auth_host = 127.0.0.1 | (String) Host providing the admin Identity API endpoint. Deprecated, use identity_uri. |
| auth_port = 35357 | (Integer) Port of the admin Identity API endpoint. Deprecated, use identity_uri. |
| auth_protocol = https | (String) Protocol of the admin Identity API endpoint. Deprecated, use identity_uri. |
| auth_section = None | (Unknown) Config Section from which to load plugin specific options |
| auth_type = None | (Unknown) Authentication type to load |
| auth_uri = None | (String) Complete public Identity API endpoint. |
| auth_version = None | (String) API version of the admin Identity API endpoint. |
| cache = None | (String) Env key for the swift cache. |
| cafile = None | (String) A PEM encoded Certificate Authority to use when verifying HTTPs connections. Defaults to system CAs. |
| certfile = None | (String) Required if identity server requires client certificate |
| check_revocations_for_cached = False | (Boolean) If true, the revocation list will be checked for cached tokens. This requires that PKI tokens are configured on the identity server. |
| delay_auth_decision = False | (Boolean) Do not handle authorization requests within the middleware, but delegate the authorization decision to downstream WSGI components. |
| enforce_token_bind = permissive | (String) Used to control the use and type of token binding. Can be set to: “disabled” to not check token binding. “permissive” (default) to validate binding information if the bind type is of a form known to the server and ignore it if not. “strict” like “permissive” but if the bind type is unknown the token will be rejected. “required” any form of token binding is needed to be allowed. Finally the name of a binding method that must be present in tokens. |
| hash_algorithms = md5 | (List) Hash algorithms to use for hashing PKI tokens. This may be a single algorithm or multiple. The algorithms are those supported by Python standard hashlib.new(). The hashes will be tried in the order given, so put the preferred one first for performance. The result of the first hash will be stored in the cache. This will typically be set to multiple values only while migrating from a less secure algorithm to a more secure one. Once all the old tokens are expired this option should be set to a single value for better performance. |
| http_connect_timeout = None | (Integer) Request timeout value for communicating with Identity API server. |
| http_request_max_retries = 3 | (Integer) How many times are we trying to reconnect when communicating with Identity API Server. |
| identity_uri = None | (String) Complete admin Identity API endpoint. This should specify the unversioned root endpoint e.g. https://localhost:35357/ |
| include_service_catalog = True | (Boolean) (Optional) Indicate whether to set the X-Service-Catalog header. If False, middleware will not ask for service catalog on token validation and will not set the X-Service-Catalog header. |
| insecure = False | (Boolean) Verify HTTPS connections. |
| keyfile = None | (String) Required if identity server requires client certificate |
| memcache_pool_conn_get_timeout = 10 | (Integer) (Optional) Number of seconds that an operation will wait to get a memcached client connection from the pool. |
| memcache_pool_dead_retry = 300 | (Integer) (Optional) Number of seconds memcached server is considered dead before it is tried again. |
| memcache_pool_maxsize = 10 | (Integer) (Optional) Maximum total number of open connections to every memcached server. |
| memcache_pool_socket_timeout = 3 | (Integer) (Optional) Socket timeout in seconds for communicating with a memcached server. |
| memcache_pool_unused_timeout = 60 | (Integer) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed. |
| memcache_secret_key = None | (String) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation. |
| memcache_security_strategy = None | (String) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization. |
| memcache_use_advanced_pool = False | (Boolean) (Optional) Use the advanced (eventlet safe) memcached client pool. The advanced pool will only work under python 2.x. |
| region_name = None | (String) The region in which the identity server can be found. |
| revocation_cache_time = 10 | (Integer) 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. |
| signing_dir = None | (String) Directory used to cache files related to PKI tokens. |
| token_cache_time = 300 | (Integer) In order to prevent excessive effort spent validating tokens, the middleware caches previously-seen tokens for a configurable duration (in seconds). Set to -1 to disable caching completely. |
| Configuration option = Default value | Description |
|---|---|
| [collector] | |
| batch_size = 1 | (Integer) Number of notification messages to wait before dispatching them |
| batch_timeout = None | (Integer) Number of seconds to wait before dispatching sampleswhen batch_size is not reached (None means indefinitely) |
| udp_address = 0.0.0.0 | (String) Address to which the UDP socket is bound. Set to an empty string to disable. |
| udp_port = 4952 | (Port number) Port to which the UDP socket is bound. |
| workers = 1 | (Integer) Number of workers for collector service. default value is 1. |
| [dispatcher_file] | |
| backup_count = 0 | (Integer) The max number of the files to keep. |
| file_path = None | (String) Name and the location of the file to record meters. |
| max_bytes = 0 | (Integer) The max size of the file. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| batch_polled_samples = True | (Boolean) To reduce polling agent load, samples are sent to the notification agent in a batch. To gain higher throughput at the cost of load set this to False. |
| executor_thread_pool_size = 64 | (Integer) Size of executor thread pool. |
| host = localhost | (String) 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. |
| http_timeout = 600 | (Integer) Timeout seconds for HTTP requests. Set it to None to disable timeout. |
| memcached_servers = None | (List) Memcached servers or None for in process cache. |
| polling_namespaces = ['compute', 'central'] | (Unknown) Polling namespace(s) to be used while resource polling |
| pollster_list = [] | (Unknown) List of pollsters (or wildcard templates) to be used while polling |
| rootwrap_config = /etc/ceilometer/rootwrap.conf | (String) Path to the rootwrap configuration file touse for running commands as root |
| shuffle_time_before_polling_task = 0 | (Integer) To reduce large requests at same time to Nova or other components from different compute agents, shuffle start time of polling task. |
| sql_expire_samples_only = False | (Boolean) Indicates if expirer expires only samples. If set true, expired samples will be deleted, but residual resource and meter definition data will remain. |
| [compute] | |
| resource_update_interval = 0 | (Integer) New instances will be discovered periodically based on this option (in seconds). By default, the agent discovers instances according to pipeline polling interval. If option is greater than 0, the instance list to poll will be updated based on this option’s interval. Measurements relating to the instances will match intervals defined in pipeline. |
| workload_partitioning = False | (Boolean) Enable work-load partitioning, allowing multiple compute agents to be run simultaneously. |
| [coordination] | |
| backend_url = None | (String) The backend URL to use for distributed coordination. If left empty, per-deployment central agent and per-host compute agent won’t do workload partitioning and will only function correctly if a single instance of that service is running. |
| check_watchers = 10.0 | (Floating point) Number of seconds between checks to see if group membership has changed |
| heartbeat = 1.0 | (Floating point) Number of seconds between heartbeats for distributed coordination. |
| [keystone_authtoken] | |
| memcached_servers = None | (List) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process. |
| [meter] | |
| meter_definitions_cfg_file = meters.yaml | (String) Configuration file for defining meter notifications. |
| [polling] | |
| partitioning_group_prefix = None | (String) Work-load partitioning group prefix. Use only if you want to run multiple polling agents with different config files. For each sub-group of the agent pool with the same partitioning_group_prefix a disjoint subset of pollsters should be loaded. |
| Configuration option = Default value | Description |
|---|---|
| [cors] | |
| allow_credentials = True | (Boolean) Indicate that the actual request can include user credentials |
| allow_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma | (List) Indicate which header field names may be used during the actual request. |
| allow_methods = GET, POST, PUT, DELETE, OPTIONS | (List) Indicate which methods can be used during the actual request. |
| allowed_origin = None | (List) Indicate whether this resource may be shared with the domain received in the requests “origin” header. |
| expose_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma | (List) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. |
| max_age = 3600 | (Integer) Maximum cache age of CORS preflight requests. |
| [cors.subdomain] | |
| allow_credentials = True | (Boolean) Indicate that the actual request can include user credentials |
| allow_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma | (List) Indicate which header field names may be used during the actual request. |
| allow_methods = GET, POST, PUT, DELETE, OPTIONS | (List) Indicate which methods can be used during the actual request. |
| allowed_origin = None | (List) Indicate whether this resource may be shared with the domain received in the requests “origin” header. |
| expose_headers = Content-Type, Cache-Control, Content-Language, Expires, Last-Modified, Pragma | (List) Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers. |
| max_age = 3600 | (Integer) Maximum cache age of CORS preflight requests. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| database_connection = None | (String) DEPRECATED - Database connection string. |
| [database] | |
| backend = sqlalchemy | (String) The back end to use for the database. |
| connection = None | (String) The SQLAlchemy connection string to use to connect to the database. |
| connection_debug = 0 | (Integer) Verbosity of SQL debugging information: 0=None, 100=Everything. |
| connection_trace = False | (Boolean) Add Python stack traces to SQL as comment strings. |
| db2nosql_resource_id_maxlen = 512 | (Integer) The max length of resources id in DB2 nosql, the value should be larger than len(hostname) * 2 as compute node’s resource id is <hostname>_<nodename>. |
| db_inc_retry_interval = True | (Boolean) If True, increases the interval between retries of a database operation up to db_max_retry_interval. |
| db_max_retries = 20 | (Integer) Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count. |
| db_max_retry_interval = 10 | (Integer) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation. |
| db_retry_interval = 1 | (Integer) Seconds between retries of a database transaction. |
| event_connection = None | (String) The connection string used to connect to the event database. (if unset, connection is used) |
| event_time_to_live = -1 | (Integer) Number of seconds that events are kept in the database for (<= 0 means forever). |
| idle_timeout = 3600 | (Integer) Timeout before idle SQL connections are reaped. |
| max_overflow = 50 | (Integer) If set, use this value for max_overflow with SQLAlchemy. |
| max_pool_size = None | (Integer) Maximum number of SQL connections to keep open in a pool. |
| max_retries = 10 | (Integer) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count. |
| metering_connection = None | (String) The connection string used to connect to the metering database. (if unset, connection is used) |
| metering_time_to_live = -1 | (Integer) Number of seconds that samples are kept in the database for (<= 0 means forever). |
| min_pool_size = 1 | (Integer) Minimum number of SQL connections to keep open in a pool. |
| mysql_sql_mode = TRADITIONAL | (String) 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= |
| pool_timeout = None | (Integer) If set, use this value for pool_timeout with SQLAlchemy. |
| retry_interval = 10 | (Integer) Interval between retries of opening a SQL connection. |
| slave_connection = None | (String) The SQLAlchemy connection string to use to connect to the slave database. |
| sqlite_db = oslo.sqlite | (String) The file name to use with SQLite. |
| sqlite_synchronous = True | (Boolean) If True, SQLite uses synchronous mode. |
| use_db_reconnect = False | (Boolean) Enable the experimental use of database reconnect on connection lost. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| nova_http_log_debug = False | (Boolean) DEPRECATED: Allow novaclient’s debug log output. (Use default_log_levels instead) |
| Configuration option = Default value | Description |
|---|---|
| [dispatcher_gnocchi] | |
| archive_policy = None | (String) The archive policy to use when the dispatcher create a new metric. |
| filter_project = gnocchi | (String) Gnocchi project used to filter out samples generated by Gnocchi service activity |
| filter_service_activity = True | (Boolean) Filter out samples generated by Gnocchi service activity |
| resources_definition_file = gnocchi_resources.yaml | (String) The Yaml file that defines mapping between samples and gnocchi resources/metrics |
| url = None | (String) DEPRECATED: URL to Gnocchi. default: autodetection |
| Configuration option = Default value | Description |
|---|---|
| [dispatcher_http] | |
| event_target = None | (String) 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. |
| target = | (String) 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 |
| timeout = 5 | (Integer) The max time in seconds to wait for a request to timeout. |
| Configuration option = Default value | Description |
|---|---|
| [event] | |
| definitions_cfg_file = event_definitions.yaml | (String) Configuration file for event definitions. |
| drop_unmatched_notifications = False | (Boolean) Drop notifications if no event definition matches. (Otherwise, we convert them with just the default traits) |
| store_raw = [] | (Multi-valued) Store the raw notification for select priority levels (info and/or error). By default, raw details are not captured. |
| [notification] | |
| ack_on_event_error = True | (Boolean) Acknowledge message when event persistence fails. |
| store_events = False | (Boolean) Save event details. |
| workers = 1 | (Integer) Number of workers for notification service, default value is 1. |
| workload_partitioning = False | (Boolean) Enable workload partitioning, allowing multiple notification agents to be run simultaneously. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| ceilometer_control_exchange = ceilometer | (String) Exchange name for ceilometer notifications. |
| cinder_control_exchange = cinder | (String) Exchange name for Cinder notifications. |
| dns_control_exchange = central | (String) Exchange name for DNS service notifications. |
| glance_control_exchange = glance | (String) Exchange name for Glance notifications. |
| heat_control_exchange = heat | (String) Exchange name for Heat notifications |
| http_control_exchanges = ['nova', 'glance', 'neutron', 'cinder'] | (Multi-valued) Exchanges name to listen for notifications. |
| ironic_exchange = ironic | (String) Exchange name for Ironic notifications. |
| keystone_control_exchange = keystone | (String) Exchange name for Keystone notifications. |
| magnum_control_exchange = magnum | (String) Exchange name for Magnum notifications. |
| neutron_control_exchange = neutron | (String) Exchange name for Neutron notifications. |
| nova_control_exchange = nova | (String) Exchange name for Nova notifications. |
| sahara_control_exchange = sahara | (String) Exchange name for Data Processing notifications. |
| sample_source = openstack | (String) Source for samples emitted on this instance. |
| swift_control_exchange = swift | (String) Exchange name for Swift notifications. |
| trove_control_exchange = trove | (String) Exchange name for DBaaS notifications. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| glance_page_size = 0 | (Integer) Number of items to request in each paginated Glance API request (parameter used by glanceclient). If this is less than or equal to 0, page size is not specified (default value in glanceclient is used). |
| Configuration option = Default value | Description |
|---|---|
| [hyperv] | |
| force_volumeutils_v1 = False | (Boolean) DEPRECATED: Force V1 volume utility class |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| hypervisor_inspector = libvirt | (String) Inspector to use for inspecting the hypervisor layer. Known inspectors are libvirt, hyperv, vmware, xenapi and powervm. |
| libvirt_type = kvm | (String) Libvirt domain type. |
| libvirt_uri = | (String) Override the default libvirt URI (which is dependent on libvirt_type). |
| Configuration option = Default value | Description |
|---|---|
| [ipmi] | |
| node_manager_init_retry = 3 | (Integer) Number of retries upon Intel Node Manager initialization failure |
| polling_retry = 3 | (Integer) Tolerance of IPMI/NM polling failures before disable this pollster. Negative indicates retrying forever. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| debug = False | (Boolean) If set to true, the logging level will be set to DEBUG instead of the default INFO level. |
| default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN, taskflow=WARN, keystoneauth=WARN, oslo.cache=INFO, dogpile.core.dogpile=INFO | (List) List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set. |
| fatal_deprecations = False | (Boolean) Enables or disables fatal status of deprecations. |
| instance_format = "[instance: %(uuid)s] " | (String) The format for an instance that is passed with the log message. |
| instance_uuid_format = "[instance: %(uuid)s] " | (String) The format for an instance UUID that is passed with the log message. |
| log_config_append = None | (String) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, logging_context_format_string). |
| log_date_format = %Y-%m-%d %H:%M:%S | (String) Defines the format string for %%(asctime)s in log records. Default: %(default)s . This option is ignored if log_config_append is set. |
| log_dir = None | (String) (Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set. |
| log_file = None | (String) (Optional) Name of log file to send logging output to. If no default is set, logging will go to stderr as defined by use_stderr. This option is ignored if log_config_append is set. |
| logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s | (String) Format string to use for log messages with context. |
| logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d | (String) Additional data to append to log message when logging level for the message is DEBUG. |
| logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s | (String) Format string to use for log messages when context is undefined. |
| logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s | (String) Prefix each line of exception output with this format. |
| logging_user_identity_format = %(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s | (String) Defines the format string for %(user_identity)s that is used in logging_context_format_string. |
| publish_errors = False | (Boolean) Enables or disables publication of error events. |
| syslog_log_facility = LOG_USER | (String) Syslog facility to receive log lines. This option is ignored if log_config_append is set. |
| use_stderr = True | (Boolean) Log output to standard error. This option is ignored if log_config_append is set. |
| use_syslog = False | (Boolean) Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set. |
| verbose = True | (Boolean) DEPRECATED: If set to false, the logging level will be set to WARNING instead of the default INFO level. |
| watch_log_file = False | (Boolean) Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log_file option is specified and Linux platform is used. This option is ignored if log_config_append is set. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| magnetodb_control_exchange = magnetodb | (String) Exchange name for Magnetodb notifications. |
| Configuration option = Default value | Description |
|---|---|
| [notification] | |
| batch_size = 1 | (Integer) Number of notification messages to wait before publishing them |
| batch_timeout = None | (Integer) Number of seconds to wait before publishing sampleswhen batch_size is not reached (None means indefinitely) |
| disable_non_metric_meters = True | (Boolean) 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. |
| pipeline_processing_queues = 10 | (Integer) Number of queues to parallelize workload across. This value should be larger than the number of active notification agents for optimal results. |
| Configuration option = Default value | Description |
|---|---|
| [oslo_policy] | |
| policy_default_rule = default | (String) Default rule. Enforced when a requested rule is not found. |
| policy_dirs = ['policy.d'] | (Multi-valued) 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. Missing or empty directories are ignored. |
| policy_file = policy.json | (String) The JSON file that defines policies. |
| Configuration option = Default value | Description |
|---|---|
| [oslo_messaging_rabbit] | |
| amqp_auto_delete = False | (Boolean) Auto-delete queues in AMQP. |
| amqp_durable_queues = False | (Boolean) Use durable queues in AMQP. |
| channel_max = None | (Integer) Maximum number of channels to allow |
| default_notification_exchange = ${control_exchange}_notification | (String) Exchange name for for sending notifications |
| default_notification_retry_attempts = -1 | (Integer) Reconnecting retry count in case of connectivity problem during sending notification, -1 means infinite retry. |
| default_rpc_exchange = ${control_exchange}_rpc | (String) Exchange name for sending RPC messages |
| default_rpc_retry_attempts = -1 | (Integer) Reconnecting retry count in case of connectivity problem during sending RPC message, -1 means infinite retry. If actual retry attempts in not 0 the rpc request could be processed more then one time |
| fake_rabbit = False | (Boolean) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake |
| frame_max = None | (Integer) The maximum byte size for an AMQP frame |
| heartbeat_interval = 1 | (Integer) How often to send heartbeats for consumer’s connections |
| heartbeat_rate = 2 | (Integer) How often times during the heartbeat_timeout_threshold we check the heartbeat. |
| heartbeat_timeout_threshold = 60 | (Integer) Number of seconds after which the Rabbit broker is considered down if heartbeat’s keep-alive fails (0 disable the heartbeat). EXPERIMENTAL |
| host_connection_reconnect_delay = 0.25 | (Floating point) Set delay for reconnection to some host which has connection error |
| kombu_compression = None | (String) EXPERIMENTAL: Possible values are: gzip, bz2. If not set compression will not be used. This option may notbe available in future versions. |
| kombu_failover_strategy = round-robin | (String) Determines how the next RabbitMQ node is chosen in case the one we are currently connected to becomes unavailable. Takes effect only if more than one RabbitMQ node is provided in config. |
| kombu_missing_consumer_retry_timeout = 60 | (Integer) How long to wait a missing client beforce abandoning to send it its replies. This value should not be longer than rpc_response_timeout. |
| kombu_reconnect_delay = 1.0 | (Floating point) How long to wait before reconnecting in response to an AMQP consumer cancel notification. |
| kombu_ssl_ca_certs = | (String) SSL certification authority file (valid only if SSL enabled). |
| kombu_ssl_certfile = | (String) SSL cert file (valid only if SSL enabled). |
| kombu_ssl_keyfile = | (String) SSL key file (valid only if SSL enabled). |
| kombu_ssl_version = | (String) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions. |
| notification_listener_prefetch_count = 100 | (Integer) Max number of not acknowledged message which RabbitMQ can send to notification listener. |
| notification_persistence = False | (Boolean) Persist notification messages. |
| notification_retry_delay = 0.25 | (Floating point) Reconnecting retry delay in case of connectivity problem during sending notification message |
| pool_max_overflow = 0 | (Integer) Maximum number of connections to create above pool_max_size. |
| pool_max_size = 10 | (Integer) Maximum number of connections to keep queued. |
| pool_recycle = 600 | (Integer) Lifetime of a connection (since creation) in seconds or None for no recycling. Expired connections are closed on acquire. |
| pool_stale = 60 | (Integer) Threshold at which inactive (since release) connections are considered stale in seconds or None for no staleness. Stale connections are closed on acquire. |
| pool_timeout = 30 | (Integer) Default number of seconds to wait for a connections to available |
| rabbit_ha_queues = False | (Boolean) Try to use HA queues in RabbitMQ (x-ha-policy: all). If you change this option, you must wipe the RabbitMQ database. In RabbitMQ 3.0, queue mirroring is no longer controlled by the x-ha-policy argument when declaring a queue. If you just want to make sure that all queues (except those with auto-generated names) are mirrored across all nodes, run: “rabbitmqctl set_policy HA ‘^(?!amq.).*’ ‘{“ha-mode”: “all”}’ “ |
| rabbit_host = localhost | (String) The RabbitMQ broker address where a single node is used. |
| rabbit_hosts = $rabbit_host:$rabbit_port | (List) RabbitMQ HA cluster host:port pairs. |
| rabbit_interval_max = 30 | (Integer) Maximum interval of RabbitMQ connection retries. Default is 30 seconds. |
| rabbit_login_method = AMQPLAIN | (String) The RabbitMQ login method. |
| rabbit_max_retries = 0 | (Integer) Maximum number of RabbitMQ connection retries. Default is 0 (infinite retry count). |
| rabbit_password = guest | (String) The RabbitMQ password. |
| rabbit_port = 5672 | (Port number) The RabbitMQ broker port where a single node is used. |
| rabbit_qos_prefetch_count = 0 | (Integer) Specifies the number of messages to prefetch. Setting to zero allows unlimited messages. |
| rabbit_retry_backoff = 2 | (Integer) How long to backoff for between retries when connecting to RabbitMQ. |
| rabbit_retry_interval = 1 | (Integer) How frequently to retry connecting with RabbitMQ. |
| rabbit_transient_queues_ttl = 1800 | (Integer) Positive integer representing duration in seconds for queue TTL (x-expires). Queues which are unused for the duration of the TTL are automatically deleted. The parameter affects only reply and fanout queues. |
| rabbit_use_ssl = False | (Boolean) Connect over SSL for RabbitMQ. |
| rabbit_userid = guest | (String) The RabbitMQ userid. |
| rabbit_virtual_host = / | (String) The RabbitMQ virtual host. |
| Configuration option = Default value | Description |
|---|---|
| [matchmaker_redis] | |
| check_timeout = 20000 | (Integer) Time in ms to wait before the transaction is killed. |
| host = 127.0.0.1 | (String) Host to locate redis. |
| password = | (String) Password for Redis server (optional). |
| port = 6379 | (Port number) Use this port to connect to redis host. |
| sentinel_group_name = oslo-messaging-zeromq | (String) Redis replica set name. |
| sentinel_hosts = | (List) List of Redis Sentinel hosts (fault tolerance mode) e.g. [host:port, host1:port ... ] |
| socket_timeout = 1000 | (Integer) Timeout in ms on blocking socket operations |
| wait_timeout = 500 | (Integer) Time in ms to wait between connection attempts. |
| Configuration option = Default value | Description |
|---|---|
| [rgw_admin_credentials] | |
| access_key = None | (String) Access key for Radosgw Admin. |
| secret_key = None | (String) Secret key for Radosgw Admin. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| rpc_backend = rabbit | (String) The messaging driver to use, defaults to rabbit. Other drivers include amqp and zmq. |
| rpc_cast_timeout = -1 | (Integer) Seconds to wait before a cast expires (TTL). The default value of -1 specifies an infinite linger period. The value of 0 specifies no linger period. Pending messages shall be discarded immediately when the socket is closed. Only supported by impl_zmq. |
| rpc_conn_pool_size = 30 | (Integer) Size of RPC connection pool. |
| rpc_poll_timeout = 1 | (Integer) The default number of seconds that poll should wait. Poll raises timeout exception when timeout expired. |
| rpc_response_timeout = 60 | (Integer) Seconds to wait for a response from a call. |
| [notification] | |
| messaging_urls = [] | (Multi-valued) Messaging URLs to listen for notifications. Example: transport://user:pass@host1:port[,hostN:portN]/virtual_host (DEFAULT/transport_url is used if empty) |
| [oslo_concurrency] | |
| disable_process_locking = False | (Boolean) Enables or disables inter-process locks. |
| lock_path = None | (String) Directory to use for lock files. For security, the specified directory should only be writable by the user running the processes that need locking. Defaults to environment variable OSLO_LOCK_PATH. If external locks are used, a lock path must be set. |
| [oslo_messaging_amqp] | |
| allow_insecure_clients = False | (Boolean) Accept clients using either SSL or plain TCP |
| broadcast_prefix = broadcast | (String) address prefix used when broadcasting to all servers |
| container_name = None | (String) Name for the AMQP container |
| group_request_prefix = unicast | (String) address prefix when sending to any server in group |
| idle_timeout = 0 | (Integer) Timeout for inactive connections (in seconds) |
| password = | (String) Password for message broker authentication |
| sasl_config_dir = | (String) Path to directory that contains the SASL configuration |
| sasl_config_name = | (String) Name of configuration file (without .conf suffix) |
| sasl_mechanisms = | (String) Space separated list of acceptable SASL mechanisms |
| server_request_prefix = exclusive | (String) address prefix used when sending to a specific server |
| ssl_ca_file = | (String) CA certificate PEM file to verify server certificate |
| ssl_cert_file = | (String) Identifying certificate PEM file to present to clients |
| ssl_key_file = | (String) Private key PEM file used to sign cert_file certificate |
| ssl_key_password = None | (String) Password for decrypting ssl_key_file (if encrypted) |
| trace = False | (Boolean) Debug: dump AMQP frames to stdout |
| username = | (String) User name for message broker authentication |
| [oslo_messaging_notifications] | |
| driver = [] | (Multi-valued) The Drivers(s) to handle sending notifications. Possible values are messaging, messagingv2, routing, log, test, noop |
| topics = notifications | (List) AMQP topic used for OpenStack notifications. |
| transport_url = None | (String) A URL representing the messaging driver to use for notifications. If not set, we fall back to the same configuration used for RPC. |
| [oslo_messaging_rabbit] | |
| rpc_listener_prefetch_count = 100 | (Integer) Max number of not acknowledged message which RabbitMQ can send to rpc listener. |
| rpc_queue_expiration = 60 | (Integer) Time to live for rpc queues without consumers in seconds. |
| rpc_reply_exchange = ${control_exchange}_rpc_reply | (String) Exchange name for receiving RPC replies |
| rpc_reply_listener_prefetch_count = 100 | (Integer) Max number of not acknowledged message which RabbitMQ can send to rpc reply listener. |
| rpc_reply_retry_attempts = -1 | (Integer) Reconnecting retry count in case of connectivity problem during sending reply. -1 means infinite retry during rpc_timeout |
| rpc_reply_retry_delay = 0.25 | (Floating point) Reconnecting retry delay in case of connectivity problem during sending reply. |
| rpc_retry_delay = 0.25 | (Floating point) Reconnecting retry delay in case of connectivity problem during sending RPC message |
| socket_timeout = 0.25 | (Floating point) Set socket timeout in seconds for connection’s socket |
| ssl = None | (Boolean) Enable SSL |
| ssl_options = None | (Dict) Arguments passed to ssl.wrap_socket |
| tcp_user_timeout = 0.25 | (Floating point) Set TCP_USER_TIMEOUT in seconds for connection’s socket |
| [publisher] | |
| telemetry_secret = change this for valid signing | (String) Secret value for signing messages. Set value empty if signing is not required to avoid computational overhead. |
| [publisher_notifier] | |
| event_topic = event | (String) The topic that ceilometer uses for event notifications. |
| metering_topic = metering | (String) The topic that ceilometer uses for metering notifications. |
| telemetry_driver = messagingv2 | (String) The driver that ceilometer uses for metering notifications. |
| Configuration option = Default value | Description |
|---|---|
| [service_types] | |
| glance = image | (String) Glance service type. |
| kwapi = energy | (String) Kwapi service type. |
| neutron = network | (String) Neutron service type. |
| neutron_lbaas_version = v2 | (String) Neutron load balancer version. |
| nova = compute | (String) Nova service type. |
| radosgw = object-store | (String) Radosgw service type. |
| swift = object-store | (String) Swift service type. |
| Configuration option = Default value | Description |
|---|---|
| [storage] | |
| max_retries = 10 | (Integer) Maximum number of connection retries during startup. Set to -1 to specify an infinite retry count. |
| retry_interval = 10 | (Integer) Interval (in seconds) between retries of connection. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| reseller_prefix = AUTH_ | (String) Swift reseller prefix. Must be on par with reseller_prefix in proxy-server.conf. |
| Configuration option = Default value | Description |
|---|---|
| [hardware] | |
| meter_definitions_file = snmp.yaml | (String) Configuration file for defining hardware snmp meters. |
| readonly_user_name = ro_snmp_user | (String) SNMPd user name of all nodes running in the cloud. |
| readonly_user_password = password | (String) SNMPd password of all the nodes running in the cloud. |
| url_scheme = snmp:// | (String) URL scheme to use for hardware nodes. |
| Configuration option = Default value | Description |
|---|---|
| [vmware] | |
| api_retry_count = 10 | (Integer) Number of times a VMware vSphere API may be retried. |
| ca_file = None | (String) CA bundle file to use in verifying the vCenter server certificate. |
| host_ip = | (String) IP address of the VMware vSphere host. |
| host_password = | (String) Password of VMware vSphere. |
| host_port = 443 | (Port number) Port of the VMware vSphere host. |
| host_username = | (String) Username of VMware vSphere. |
| insecure = False | (Boolean) If true, the vCenter server certificate is not verified. If false, then the default CA truststore is used for verification. This option is ignored if “ca_file” is set. |
| task_poll_interval = 0.5 | (Floating point) Sleep time in seconds for polling an ongoing async task. |
| wsdl_location = None | (String) Optional vim service WSDL location e.g http://<server>/vimService.wsdl. Optional over-ride to default location for bug work-arounds. |
| Configuration option = Default value | Description |
|---|---|
| [xenapi] | |
| connection_password = None | (String) Password for connection to XenServer/Xen Cloud Platform. |
| connection_url = None | (String) URL for connection to XenServer/Xen Cloud Platform. |
| connection_username = root | (String) Username for connection to XenServer/Xen Cloud Platform. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| zaqar_control_exchange = zaqar | (String) Exchange name for Messaging service notifications. |
| Configuration option = Default value | Description |
|---|---|
| [DEFAULT] | |
| rpc_zmq_bind_address = * | (String) ZeroMQ bind address. Should be a wildcard (*), an ethernet interface, or IP. The “host” option should point or resolve to this address. |
| rpc_zmq_bind_port_retries = 100 | (Integer) Number of retries to find free port number before fail with ZMQBindError. |
| rpc_zmq_concurrency = eventlet | (String) Type of concurrency used. Either “native” or “eventlet” |
| rpc_zmq_contexts = 1 | (Integer) Number of ZeroMQ contexts, defaults to 1. |
| rpc_zmq_host = localhost | (String) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match “host” option, if running Nova. |
| rpc_zmq_ipc_dir = /var/run/openstack | (String) Directory for holding IPC sockets. |
| rpc_zmq_matchmaker = redis | (String) MatchMaker driver. |
| rpc_zmq_max_port = 65536 | (Integer) Maximal port number for random ports range. |
| rpc_zmq_min_port = 49152 | (Port number) Minimal port number for random ports range. |
| rpc_zmq_topic_backlog = None | (Integer) Maximum number of ingress messages to locally buffer per topic. Default is unlimited. |
| use_pub_sub = True | (Boolean) Use PUB/SUB pattern for fanout methods. PUB/SUB always uses proxy. |
| zmq_target_expire = 120 | (Integer) Expiration timeout in seconds of a name service record about existing target ( < 0 means no timeout). |
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.