Add an API configuration section to docs

Uses the help text from where the options are defined.

Closes-Bug: #1370030

Change-Id: I77e048ea37492c32a8d81c5d27262a4398ffaf3a
This commit is contained in:
Chris Dent 2014-09-16 13:48:04 +01:00
parent 1ac00d4a70
commit 7b89798be3
1 changed files with 16 additions and 1 deletions

View File

@ -41,7 +41,6 @@ metering_topic metering the topic
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
metering_api_port 8777 The port for the ceilometer API server
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
@ -52,6 +51,22 @@ glance_page_size 0 Number of
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 authentication
==============================