diff --git a/etc/aodh/aodh-config-generator.conf b/aodh-config-generator.conf similarity index 100% rename from etc/aodh/aodh-config-generator.conf rename to aodh-config-generator.conf diff --git a/doc/source/configuration.rst b/doc/source/configuration.rst index 686bd9c2d..a78856396 100644 --- a/doc/source/configuration.rst +++ b/doc/source/configuration.rst @@ -13,9 +13,22 @@ License for the specific language governing permissions and limitations under the License. -======================= - Configuration Options -======================= + +============= +Configuration +============= + +Configure Aodh by editing `/etc/aodh/aodh.conf`. + +No config file is provided with the source code, but one can be easily created +by running: + +:: + + tox -e genconfig + +This command will create an `etc/aodh/aodh.conf` file which can be used as a +base for the default configuration file at `/etc/aodh/aodh.conf`. For the list and description of configuration options that can be set for Aodh in order to set up the services please see the diff --git a/etc/aodh/README-aodh.conf.txt b/etc/aodh/README-aodh.conf.txt deleted file mode 100644 index 7d7a03623..000000000 --- a/etc/aodh/README-aodh.conf.txt +++ /dev/null @@ -1,4 +0,0 @@ -To generate the sample aodh.conf file, run the following -command from the top-level aodh directory: - -tox -egenconfig diff --git a/tox.ini b/tox.ini index a89b04a15..3e3a694c4 100644 --- a/tox.ini +++ b/tox.ini @@ -12,7 +12,7 @@ setenv = VIRTUAL_ENV={envdir} passenv = OS_TEST_TIMEOUT OS_STDOUT_CAPTURE OS_STDERR_CAPTURE OS_LOG_CAPTURE commands = python setup.py testr --slowest --testr-args="{posargs}" - oslo-config-generator --config-file=etc/aodh/aodh-config-generator.conf + oslo-config-generator --config-file=aodh-config-generator.conf whitelist_externals = bash # TODO(ityaptin): With separation tests to unit and functional folders we need @@ -76,7 +76,7 @@ deps = .[doc] commands = sphinx-build -a -E -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html [testenv:genconfig] -commands = oslo-config-generator --config-file=etc/aodh/aodh-config-generator.conf +commands = oslo-config-generator --config-file=aodh-config-generator.conf [testenv:docs] deps = .[doc]