diff --git a/doc/source/configuration/index.rst b/doc/source/configuration/index.rst new file mode 100644 index 0000000000..b6743e6816 --- /dev/null +++ b/doc/source/configuration/index.rst @@ -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 diff --git a/doc/source/contributor/configuration.rst b/doc/source/contributor/configuration.rst index e977b3ecd2..d69f27f53b 100644 --- a/doc/source/contributor/configuration.rst +++ b/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 `_ -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 ~~~~~~~ diff --git a/doc/source/index.rst b/doc/source/index.rst index 7ca3c35b51..0b4ed2e5f8 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -37,6 +37,7 @@ Overview install/index contributor/index admin/index + configuration/index webapi/index Appendix