Merge "Remove duplicated config doc"
This commit is contained in:
Jenkins
Gerrit Code Review
commit
5f169d8f6e
@ -17,156 +17,10 @@
|
|||||||
Configuration Options
|
Configuration Options
|
||||||
=======================
|
=======================
|
||||||
|
|
||||||
Ceilometer specific
|
For the list and description of configuration options that can be set for Ceilometer in
|
||||||
===================
|
order to set up the services please see the
|
||||||
|
`Telemetry section <http://docs.openstack.org/trunk/config-reference/content/ch_configuring-openstack-telemetry.html>`_
|
||||||
The following table lists the ceilometer specific options in the global configuration file.
|
in the OpenStack Manuals Configuration Reference.
|
||||||
Please note that ceilometer uses openstack-common extensively, which requires that
|
|
||||||
the other parameters are set appropriately. For information we are listing the configuration
|
|
||||||
elements that we use after the ceilometer specific elements.
|
|
||||||
|
|
||||||
If you use sql alchemy, its specific parameters will need to be set.
|
|
||||||
|
|
||||||
|
|
||||||
=============================== ==================================== ==============================================================
|
|
||||||
Parameter Default Note
|
|
||||||
=============================== ==================================== ==============================================================
|
|
||||||
api_paste_config api_paste.ini Configuration file for WSGI definition of the API
|
|
||||||
nova_control_exchange nova Exchange name for Nova notifications
|
|
||||||
glance_control_exchange glance Exchange name for Glance notifications
|
|
||||||
cinder_control_exchange cinder Exchange name for Cinder notifications
|
|
||||||
neutron_control_exchange neutron Exchange name for Neutron notifications
|
|
||||||
sahara_control_exchange sahara Exchange name for Data Processing notifications
|
|
||||||
keystone_control_exchange keystone Exchange name for Keystone notifications
|
|
||||||
heat_control_exchange heat Exchange name for Heat notifications
|
|
||||||
trove_control_exchange trove Exchange name for DBaaS notifications
|
|
||||||
metering_secret change this or be hacked Secret value for signing metering messages
|
|
||||||
metering_topic metering the topic ceilometer uses for metering messages
|
|
||||||
sample_source openstack The source name of emitted samples
|
|
||||||
control_exchange ceilometer AMQP exchange to connect to if using RabbitMQ or Qpid
|
|
||||||
database_connection mongodb://localhost:27017/ceilometer Database connection string
|
|
||||||
reseller_prefix AUTH\_ Prefix used by swift for reseller token
|
|
||||||
nova_http_log_debug False Log request/response parameters between nova and ceilometer
|
|
||||||
glance_page_size 0 Number of items to request in each paginated Glance API
|
|
||||||
request (parameter used by glancecelient). If this is less
|
|
||||||
than or equal to 0, page size is not specified (default value
|
|
||||||
in glanceclient is used). It is better to check and set
|
|
||||||
appropriate value in line with each environment when calling
|
|
||||||
glanceclient, than to define higher default value.
|
|
||||||
=============================== ==================================== ==============================================================
|
|
||||||
|
|
||||||
API Configuration
|
|
||||||
=================
|
|
||||||
|
|
||||||
The following options may be used under an [api] section.
|
|
||||||
|
|
||||||
=============================== ==================================== ===============================================================
|
|
||||||
Parameter Default Note
|
|
||||||
=============================== ==================================== ===============================================================
|
|
||||||
host 0.0.0.0 The listen IP for the API service
|
|
||||||
port 8777 The listen port for the API service
|
|
||||||
enable_reverse_dns_lookup False Set to False if your environment does not need or have DNS
|
|
||||||
server, otherwise it will delay the response from the api.
|
|
||||||
pecan_debug The value of DEFAULT.debug Toggle Pecan Debug Middleware. Set to false when using multiple
|
|
||||||
processes with mod_wsgi.
|
|
||||||
=============================== ==================================== ===============================================================
|
|
||||||
|
|
||||||
Service polling configuration
|
|
||||||
==============================
|
|
||||||
|
|
||||||
The following options must be placed under a [service_types] section
|
|
||||||
and will be used by Ceilometer to retrieve information from OpenStack
|
|
||||||
components.
|
|
||||||
|
|
||||||
=============================== ==================================== ==============================================================
|
|
||||||
Parameter Default Note
|
|
||||||
=============================== ==================================== ==============================================================
|
|
||||||
nova compute The service type for nova
|
|
||||||
neutron network The service type for neutron
|
|
||||||
glance image The service type for glance
|
|
||||||
swift object-store The service type for swift
|
|
||||||
kwapi energy The service type for kwapi
|
|
||||||
=============================== ==================================== ==============================================================
|
|
||||||
|
|
||||||
Service polling authentication
|
|
||||||
==============================
|
|
||||||
|
|
||||||
The following options must be placed under a [service_credentials] section
|
|
||||||
and will be used by Ceilometer to retrieve information from OpenStack
|
|
||||||
components.
|
|
||||||
|
|
||||||
=============================== ==================================== ==============================================================
|
|
||||||
Parameter Default Note
|
|
||||||
=============================== ==================================== ==============================================================
|
|
||||||
os_username ceilometer Username to use for openstack service access
|
|
||||||
os_password admin Password to use for openstack service access
|
|
||||||
os_tenant_id Tenant ID to use for openstack service access
|
|
||||||
os_tenant_name admin Tenant name to use for openstack service access
|
|
||||||
os_auth_url http://localhost:5000/v2.0 Auth URL to use for openstack service access
|
|
||||||
os_endpoint_type publicURL Endpoint type in the catalog to use to access services
|
|
||||||
=============================== ==================================== ==============================================================
|
|
||||||
|
|
||||||
Keystone Middleware Authentication
|
|
||||||
==================================
|
|
||||||
|
|
||||||
The following table lists the Keystone middleware authentication options which are used to get admin token.
|
|
||||||
Please note that these options need to be under [keystone_authtoken] section.
|
|
||||||
|
|
||||||
=============================== ==================================== ==============================================================
|
|
||||||
Parameter Default Note
|
|
||||||
=============================== ==================================== ==============================================================
|
|
||||||
auth_host The host providing the Keystone service API endpoint for
|
|
||||||
validating and requesting tokens
|
|
||||||
auth_port 35357 The port used to validate tokens
|
|
||||||
auth_protocol https The protocol used to validate tokens
|
|
||||||
auth_uri auth_protocol://auth_host:auth_port The full URI used to validate tokens
|
|
||||||
admin_token Either this or the following three options are required. If
|
|
||||||
set, this is a single shared secret with the Keystone
|
|
||||||
configuration used to validate tokens.
|
|
||||||
admin_user User name for retrieving admin token
|
|
||||||
admin_password Password for retrieving admin token
|
|
||||||
admin_tenant_name Tenant name for retrieving admin token
|
|
||||||
signing_dir The cache directory for signing certificate
|
|
||||||
certfile Required if Keystone server requires client cert
|
|
||||||
keyfile Required if Keystone server requires client cert. This can be
|
|
||||||
the same as certfile if the certfile includes the private key.
|
|
||||||
=============================== ==================================== ==============================================================
|
|
||||||
|
|
||||||
VMware Configuration Options
|
|
||||||
============================
|
|
||||||
|
|
||||||
The following lists the various options that the VMware driver supports and must be placed
|
|
||||||
under a section called '[vmware]'.
|
|
||||||
|
|
||||||
========================== ==================================== =================================================================
|
|
||||||
Parameter Default Note
|
|
||||||
========================== ==================================== =================================================================
|
|
||||||
host_ip "" (Str) IP address of the VMware Vsphere host.
|
|
||||||
host_password "" (Str) Password of VMware Vsphere.
|
|
||||||
host_username "" (Str) Username of VMware Vsphere.
|
|
||||||
host_port 443 (Int) Listening Port of VMware Vsphere host.
|
|
||||||
api_retry_count 10 (Int) Number of times a VMware Vsphere API must be retried.
|
|
||||||
task_poll_interval 0.5 (Float) Sleep time in seconds for polling an ongoing async task.
|
|
||||||
wsdl_location None (Str) Optional vim Service WSDL location
|
|
||||||
e.g http://<server>/vimService.wsdl. Optional over-ride to
|
|
||||||
default location for bug work-arounds.
|
|
||||||
========================== ==================================== =================================================================
|
|
||||||
|
|
||||||
SQL Alchemy
|
|
||||||
===========
|
|
||||||
|
|
||||||
========================== ==================================== ==============================================================
|
|
||||||
Parameter Default Note
|
|
||||||
========================== ==================================== ==============================================================
|
|
||||||
sql_connection_debug 0 Verbosity of SQL debugging information. 0=None, 100=Everything
|
|
||||||
sql_connection_trace False Add python stack traces to SQL as comment strings
|
|
||||||
sql_idle_timeout 3600 timeout before idle sql connections are reaped
|
|
||||||
sql_max_retries 10 maximum db connection retries during startup.
|
|
||||||
(setting -1 implies an infinite retry count)
|
|
||||||
sql_retry_interval 10 interval between retries of opening a sql connection
|
|
||||||
mysql_engine InnoDB MySQL engine to use
|
|
||||||
sqlite_synchronous True If passed, use synchronous mode for sqlite
|
|
||||||
========================== ==================================== ==============================================================
|
|
||||||
|
|
||||||
HBase
|
HBase
|
||||||
===================
|
===================
|
||||||
@ -208,189 +62,6 @@ To find out more about supported storage backends please take a look on the
|
|||||||
|
|
||||||
.. _Apache: https://hbase.apache.org/book/quickstart.html
|
.. _Apache: https://hbase.apache.org/book/quickstart.html
|
||||||
|
|
||||||
Event Conversion
|
|
||||||
================
|
|
||||||
|
|
||||||
[notification] configuration section switches on events storing.
|
|
||||||
|
|
||||||
================================== ====================================== ==============================================================
|
|
||||||
Parameter Default Note
|
|
||||||
================================== ====================================== ==============================================================
|
|
||||||
store_events False Boolean variable that switches on/off event storage
|
|
||||||
ack_on_event_error True Acknowledge message when event persistence fails
|
|
||||||
messaging_urls [] Messaging URLs to listen for notifications. Example:
|
|
||||||
transport://user:pass@host1:port[,hostN:portN]/virtual_host
|
|
||||||
(DEFAULT/transport_url is used if empty)
|
|
||||||
================================== ====================================== ==============================================================
|
|
||||||
|
|
||||||
The following options in the [event] configuration section affect the extraction of Event data from notifications.
|
|
||||||
|
|
||||||
================================== ====================================== ==============================================================
|
|
||||||
Parameter Default Note
|
|
||||||
================================== ====================================== ==============================================================
|
|
||||||
drop_unmatched_notifications False If set to True, then notifications with no matching event
|
|
||||||
definition will be dropped.
|
|
||||||
(Notifications will *only* be dropped if this is True)
|
|
||||||
definitions_cfg_file event_definitions.yaml Name of event definitions config file (yaml format)
|
|
||||||
================================== ====================================== ==============================================================
|
|
||||||
|
|
||||||
Alarming
|
|
||||||
========
|
|
||||||
|
|
||||||
The following options in the [alarm] configuration section affect the configuration of alarm services
|
|
||||||
|
|
||||||
============================== ============================ =====================================================================================
|
|
||||||
Parameter Default Note
|
|
||||||
============================== ============================ =====================================================================================
|
|
||||||
evaluation_service default Driver to use for alarm evaluation service. DEPRECATED:
|
|
||||||
"singleton" and "partitioned" alarm evaluator services will be removed in Kilo
|
|
||||||
in favour of the default alarm evaluation service using tooz for partitioning
|
|
||||||
evaluation_interval 60 Period of evaluation cycle, should be >= than configured pipeline interval for
|
|
||||||
collection of underlying metrics
|
|
||||||
notifier_rpc_topic alarm_notifier The topic that ceilometer uses for alarm notifier messages
|
|
||||||
partition_rpc_topic alarm_partition_coordination The topic that ceilometer uses for alarm partition coordination messages
|
|
||||||
DEPRECATED: RPC-based partitioned alarm evaluation service will be removed in Kilo
|
|
||||||
in favour of the default alarm evaluation service using tooz for partitioning
|
|
||||||
rest_notifier_certificate_file SSL Client certificate for REST notifier
|
|
||||||
rest_notifier_certificate_key SSL Client private key for REST notifier
|
|
||||||
rest_notifier_ssl_verify True Whether to verify the SSL Server certificate when calling alarm action
|
|
||||||
rest_notifier_max_retries 0 Number of retries for REST notifier
|
|
||||||
record_history True Record alarm change events
|
|
||||||
user_alarm_quota None Maximum number of alarms defined for a user
|
|
||||||
project_alarm_quota None Maximum number of alarms defined for a project
|
|
||||||
============================== ============================ =====================================================================================
|
|
||||||
|
|
||||||
|
|
||||||
Collector
|
|
||||||
=========
|
|
||||||
|
|
||||||
The following options in the [collector] configuration section affect the collector service
|
|
||||||
|
|
||||||
===================================== ====================================== ==============================================================
|
|
||||||
Parameter Default Note
|
|
||||||
===================================== ====================================== ==============================================================
|
|
||||||
requeue_sample_on_dispatcher_error False Requeue the sample on the collector sample queue when the
|
|
||||||
collector fails to dispatch it. This option is only valid if
|
|
||||||
the sample comes from the notifier publisher
|
|
||||||
udp_address 0.0.0.0 Address to which the UDP socket is bound. Set to an empty
|
|
||||||
string to disable
|
|
||||||
udp_port 4952 Port to which the UDP socket is bound
|
|
||||||
===================================== ====================================== ==============================================================
|
|
||||||
|
|
||||||
|
|
||||||
Coordination
|
|
||||||
============
|
|
||||||
|
|
||||||
Ceilometer agents are using tooz library as a coordination tool, and there are
|
|
||||||
several options described in the [coordination] section.
|
|
||||||
|
|
||||||
============ ========= ======================================================
|
|
||||||
Parameter Default Note
|
|
||||||
============ ========= ======================================================
|
|
||||||
backend_url 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
|
|
||||||
heartbeat 1.0 Number of seconds between heartbeats for distributed
|
|
||||||
coordination
|
|
||||||
============ ========= ======================================================
|
|
||||||
|
|
||||||
|
|
||||||
Compute
|
|
||||||
=======
|
|
||||||
|
|
||||||
Some of the compute agent options need to be defined in [compute] section.
|
|
||||||
|
|
||||||
====================== ========= ======================================================
|
|
||||||
Parameter Default Note
|
|
||||||
====================== ========= ======================================================
|
|
||||||
workload_partitioning False Enable work-load partitioning, allowing multiple
|
|
||||||
compute agents to be run simultaneously.
|
|
||||||
====================== ========= ======================================================
|
|
||||||
|
|
||||||
|
|
||||||
General options
|
|
||||||
===============
|
|
||||||
|
|
||||||
The following is the list of openstack-common options that we use:
|
|
||||||
|
|
||||||
=========================== ==================================== ==============================================================
|
|
||||||
Parameter Default Note
|
|
||||||
=========================== ==================================== ==============================================================
|
|
||||||
default_notification_level INFO Default notification level for outgoing notifications
|
|
||||||
default_publisher_id $host Default publisher_id for outgoing notifications
|
|
||||||
bind_host 0.0.0.0 IP address to listen on
|
|
||||||
bind_port 9292 Port numver to listen on
|
|
||||||
port 5672 Rabbit MQ port to liste on
|
|
||||||
fake_rabbit False If passed, use a fake RabbitMQ provider
|
|
||||||
publish_errors False publish error events
|
|
||||||
use_stderr True Log output to standard error
|
|
||||||
logfile_mode 0644 Default file mode used when creating log files
|
|
||||||
log_dir Log output to a per-service log file in named directory
|
|
||||||
log_file Log output to a named file
|
|
||||||
log_format date-time level name msg Log format
|
|
||||||
log_date_format YYYY-MM-DD hh:mm:ss Log date format
|
|
||||||
log_config Logging configuration file used. The options specified in that
|
|
||||||
config file will override any other logging options specified
|
|
||||||
in Ceilometer config file.
|
|
||||||
default_log_levels ['amqplib=WARN',sqlalchemy=WARN,...] Default log level per components
|
|
||||||
notification_topics ['notifications', ] AMQP topic used for openstack notifications
|
|
||||||
enabled_apis ['ec2', 'osapi_compute'] List of APIs to enable by default
|
|
||||||
verbose False Print more verbose output
|
|
||||||
debug False Print debugging output
|
|
||||||
state_path currentdir Top-level directory for maintaining nova state
|
|
||||||
sqlite_db nova.sqlite file name for sqlite
|
|
||||||
sql_connection sqlite:///$state_path/$sqlite_db connection string for sql database
|
|
||||||
matchmaker_ringfile /etc/nova/matchmaker_ring.json Matchmaker ring file (JSON)
|
|
||||||
rpc_zmq_bind_address '*' ZeroMQ bind address
|
|
||||||
rpc_zmq_matchmaker ceilometer.openstack.common.rpc. MatchMaker drivers
|
|
||||||
matchmaker.MatchMakerLocalhost
|
|
||||||
rpc_zmq_port 9501 ZeroMQ receiver listening port
|
|
||||||
rpc_zmq_port_pub 9502 ZeroMQ fanout publisher port
|
|
||||||
rpc_zmq_contexts 1 Number of ZeroMQ contexts
|
|
||||||
rpc_zmq_ipc_dir /var/run/openstack Directory for holding IPC sockets
|
|
||||||
rabbit_port 5672 The RabbitMQ broker port where a single node is used
|
|
||||||
rabbit_host localhost The RabbitMQ broker address where a single node is used
|
|
||||||
rabbit_hosts ['$rabbit_host:$rabbit_port'] The list of rabbit hosts to listen to
|
|
||||||
rabbit_userid guest the RabbitMQ userid
|
|
||||||
rabbit_password guest the RabbitMQ password
|
|
||||||
rabbit_virtual_host / the RabbitMQ virtual host
|
|
||||||
rabbit_retry_interval 1 how frequently to retry connecting with RabbitMQ
|
|
||||||
rabbit_retry_backoff 2 how long to backoff for between retries when connecting
|
|
||||||
rabbit_max_retries 0 maximum retries with trying to connect to RabbitMQ
|
|
||||||
(the default of 0 implies an infinite retry count)
|
|
||||||
rabbit_durable_queues False use durable queues in RabbitMQ
|
|
||||||
rabbit_use_ssl False connect over SSL for RabbitMQ
|
|
||||||
rabbit_durable_queues False use durable queues in RabbitMQ
|
|
||||||
rabbit_ha_queues False use H/A queues in RabbitMQ (x-ha-policy: all).
|
|
||||||
kombu_ssl_version SSL version to use (valid only if SSL enabled)
|
|
||||||
kombu_ssl_keyfile SSL key file (valid only if SSL enabled)
|
|
||||||
kombu_ssl_certfile SSL cert file (valid only if SSL enabled)
|
|
||||||
kombu_ssl_ca_certs SSL certification authority file
|
|
||||||
qpid_hostname localhost Qpid broker hostname
|
|
||||||
qpid_port 5672 Qpid broker port
|
|
||||||
qpid_username Username for qpid connection
|
|
||||||
qpid_password Password for qpid connection
|
|
||||||
qpid_sasl_mechanisms Space separated list of SASL mechanisms to use for auth
|
|
||||||
qpid_reconnect_timeout 0 Reconnection timeout in seconds
|
|
||||||
qpid_reconnect_limit 0 Max reconnections before giving up
|
|
||||||
qpid_reconnect_interval_min 0 Minimum seconds between reconnection attempts
|
|
||||||
qpid_reconnect_interval_max 0 Maximum seconds between reconnection attempts
|
|
||||||
qpid_reconnect_interval 0 Equivalent to setting max and min to the same value
|
|
||||||
qpid_heartbeat 60 Seconds between connection keepalive heartbeats
|
|
||||||
qpid_protocol tcp Transport to use, either 'tcp' or 'ssl'
|
|
||||||
qpid_reconnect True Automatically reconnect
|
|
||||||
qpid_tcp_nodelay True Disable Nagle algorithm
|
|
||||||
rpc_backend kombu The messaging module to use, defaults to kombu.
|
|
||||||
rpc_thread_pool_size 64 Size of RPC thread pool
|
|
||||||
rpc_conn_pool_size 30 Size of RPC connection pool
|
|
||||||
rpc_response_timeout 60 Seconds to wait for a response from call or multicall
|
|
||||||
rpc_cast_timeout 30 Seconds to wait before a cast expires (TTL).
|
|
||||||
Only supported by impl_zmq.
|
|
||||||
dispatchers database The list of dispatchers to process metering data.
|
|
||||||
=========================== ==================================== ==============================================================
|
|
||||||
|
|
||||||
|
|
||||||
Sample Configuration file
|
Sample Configuration file
|
||||||
=========================
|
=========================
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user