openstack/ceilometer
Code Issues Proposed changes

add configuration folder

Browse Source 
move conf generation to configuration folder

Change-Id: I2252c71cb0c596967c694ea3e47179fca0d4a375
Closes-Bug: #1706156
This commit is contained in:
gord chung 2017-07-24 22:50:43 +00:00
parent 1e60a368ae
commit 008c0f65cc
3 changed files with 28 additions and 17 deletions
doc/source
configuration
index.rst
contributor
configuration.rst
index.rst

24
doc/source/configuration/index.rst Normal file

@ -0,0 +1,24 @@
.. _configuring:
================================
Ceilometer Configuration Options
================================
Ceilometer Sample Configuration File
====================================
Configure Ceilometer by editing /etc/ceilometer/ceilometer.conf.
No config file is provided with the source code, it will be created during
the installation. In case where no configuration file was installed, one
can be easily created by running::
oslo-config-generator \
--config-file=/etc/ceilometer/ceilometer-config-generator.conf \
--output-file=/etc/ceilometer/ceilometer.conf
The following is a sample Ceilometer configuration for adaptation and use. It is
auto-generated from Ceilometer when this documentation is built, and can also be
viewed in `file form <_static/ceilometer.conf.sample>`_.
.. literalinclude:: ../_static/ceilometer.conf.sample

20
doc/source/contributor/configuration.rst

@ -13,23 +13,9 @@
License for the specific language governing permissions and limitations
under the License.
=======================
Configuration Options
=======================
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>`_
in the OpenStack Manuals Configuration Reference.
Sample Configuration file
~~~~~~~~~~~~~~~~~~~~~~~~~
The sample configuration file for Ceilometer, named
:file:`etc/ceilometer/ceilometer.conf.sample`, was removed from version
control after the Icehouse release. You can generate this sample configuration
file by running ``tox -e genconfig``.
===============
Configuration
===============
Polling
~~~~~~~

1
doc/source/index.rst

@ -37,6 +37,7 @@ Overview
install/index
contributor/index
admin/index
configuration/index
webapi/index
Appendix