diff --git a/doc/source/configuration/index.rst b/doc/source/configuration/index.rst new file mode 100644 index 000000000..736851f80 --- /dev/null +++ b/doc/source/configuration/index.rst @@ -0,0 +1,22 @@ +.. _configuring: + +========================== +Aodh Configuration Options +========================== + +Aodh Sample Configuration File +============================== + +Configure Aodh by editing /etc/aodh/aodh.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:: + + aodh-config-generator + +The following is a sample Aodh configuration for adaptation and use. It is +auto-generated from Aodh when this documentation is built, and can also be +viewed in `file form <_static/aodh.conf.sample>`_. + +.. literalinclude:: ../_static/aodh.conf.sample diff --git a/doc/source/contributor/configuration.rst b/doc/source/contributor/configuration.rst deleted file mode 100644 index 70de84866..000000000 --- a/doc/source/contributor/configuration.rst +++ /dev/null @@ -1,36 +0,0 @@ -.. - Copyright 2012 New Dream Network, LLC (DreamHost) - - Licensed under the Apache License, Version 2.0 (the "License"); you may - not use this file except in compliance with the License. You may obtain - a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, WITHOUT - WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the - License for the specific language governing permissions and limitations - under the License. - - -============= -Configuration -============= - -Aodh Sample Configuration File -============================== - -Configure Aodh by editing /etc/aodh/aodh.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:: - - aodh-config-generator - -The following is a sample Aodh configuration for adaptation and use. It is -auto-generated from Aodh when this documentation is built, and can also be -viewed in `file form <_static/aodh.conf.sample>`_. - -.. literalinclude:: ../_static/aodh.conf.sample diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst index d7f8685bd..fe11f1752 100644 --- a/doc/source/contributor/index.rst +++ b/doc/source/contributor/index.rst @@ -41,7 +41,6 @@ Developer Documentation :maxdepth: 2 install/index - configuration testing contributing event-alarm diff --git a/doc/source/index.rst b/doc/source/index.rst index 6d14b2b57..b522cd2d1 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -28,6 +28,7 @@ collected by Ceilometer or Gnocchi. install/index contributor/index admin/index + configuration/index .. toctree:: :maxdepth: 1