Add general options
Add general openstack-common options to the documentation. Fixes Bug #1063709 Add missing references and fix formatting in folsom.rst. Change-Id: Idccc32db021e85c70e9d377c8988e94d8a84b5d0 Signed-off-by: Doug Hellmann <doug.hellmann@dreamhost.com>
This commit is contained in:
Nicolas Barcet (nijaba)
parent
55e13884ed
commit
ef6ba4b6a0
@ -17,10 +17,14 @@
|
||||
Configuration Options
|
||||
=======================
|
||||
|
||||
Ceilometer specific
|
||||
===================
|
||||
|
||||
The following table lists the ceilometer specific option in the global configuration file.
|
||||
Please note that ceilometer uses openstack-common extensively, which requires that
|
||||
the other parameters are set appropriately. If you use sql alchemy, it's specific
|
||||
paramater will need to be set.
|
||||
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 paramaters will need to be set.
|
||||
|
||||
|
||||
========================== ==================================== ==============================================================
|
||||
@ -43,9 +47,14 @@ os-tenant-name admin Tenant name to
|
||||
os-auth-url http://localhost:5000/v2.0 Auth URL to use for openstack service access
|
||||
database_connection mongodb://localhost:27017/ceilometer Database connection string
|
||||
metering_api_port 9000 The port for the ceilometer API server
|
||||
================================================================================================================================
|
||||
========================== ==================================== ==============================================================
|
||||
|
||||
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
|
||||
@ -56,3 +65,77 @@ mysql_engine InnoDB MySQL engine t
|
||||
sqlite_synchronous True If passed, use synchronous mode for sqlite
|
||||
========================== ==================================== ==============================================================
|
||||
|
||||
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
|
||||
logdir Log output to a per-service log file in named directory
|
||||
logfile Log output to a named 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
|
||||
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.
|
||||
=========================== ==================================== ==============================================================
|
||||
|
||||
@ -13,6 +13,8 @@
|
||||
License for the specific language governing permissions and limitations
|
||||
under the License.
|
||||
|
||||
.. _measurements:
|
||||
|
||||
==============
|
||||
Measurements
|
||||
==============
|
||||
|
||||
@ -20,30 +20,35 @@ Version 0.1 (Folsom)
|
||||
This is the first release of ceilometer. Please take all appropriate caution
|
||||
in using it, as it is a technology preview at this time.
|
||||
|
||||
It is curently tested to work with OpenStack 2012.2 Folsom. Due to its use of
|
||||
openstack-common, and the modification that were made in term of notification
|
||||
to many other components (glance, cinder, quantum), it will not easily work
|
||||
with any prior version of OpenStack.
|
||||
1. Version of OpenStack
|
||||
It is curently tested to work with OpenStack 2012.2 Folsom. Due to its use of
|
||||
openstack-common, and the modification that were made in term of notification
|
||||
to many other components (glance, cinder, quantum), it will not easily work
|
||||
with any prior version of OpenStack.
|
||||
|
||||
Currently covered components are: Nova, Nova-network, Glance, Cinder and
|
||||
Quantum. Notably, there is no support yet for Swift and it was decided not
|
||||
to support nova-volume in favor of Cinder. A detailed list of meters covered
|
||||
per component can be found at:
|
||||
xxxx
|
||||
2. Components
|
||||
Currently covered components are: Nova, Nova-network, Glance, Cinder and
|
||||
Quantum. Notably, there is no support yet for Swift and it was decided not
|
||||
to support nova-volume in favor of Cinder. A detailed list of meters covered
|
||||
per component can be found at in :doc:`../measurements`.
|
||||
|
||||
Quantum delete notifications do not include the same metadata as the other
|
||||
messages, so we ignore them for now. This isn't ideal, since it may mean we
|
||||
miss charging for some amount of time, but it is better than throwing away the
|
||||
existing metadata for a resource when it is deleted.
|
||||
|
||||
The only tested and complete database backend is currently MongoDB, the
|
||||
SQLAlchemy one is still work in progress.
|
||||
3. Quantum delete events
|
||||
Quantum delete notifications do not include the same metadata as the other
|
||||
messages, so we ignore them for now. This isn't ideal, since it may mean we
|
||||
miss charging for some amount of time, but it is better than throwing away the
|
||||
existing metadata for a resource when it is deleted.
|
||||
|
||||
The current best source of information on how to deploy this project is found
|
||||
as the devstack implementation but feel free to come to #openstack-metering on
|
||||
freenode for more info.
|
||||
4. Database backend
|
||||
The only tested and complete database backend is currently MongoDB, the
|
||||
SQLAlchemy one is still work in progress.
|
||||
|
||||
Please note that metering can generate lots of data very quickly. Have a look
|
||||
at the following spreadsheet to evaluate what you will end up with.
|
||||
http://wiki.openstack.org/EfficientMetering#Volume_of_data
|
||||
5. Installation
|
||||
The current best source of information on how to deploy this project is found
|
||||
as the devstack implementation but feel free to come to #openstack-metering on
|
||||
freenode for more info.
|
||||
|
||||
6. Volume of data
|
||||
Please note that metering can generate lots of data very quickly. Have a look
|
||||
at the following spreadsheet to evaluate what you will end up with.
|
||||
|
||||
http://wiki.openstack.org/EfficientMetering#Volume_of_data
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user