diff --git a/doc/source/conf.py b/doc/source/conf.py index 01305e034..53e4b9883 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -32,7 +32,8 @@ extensions = ['sphinx.ext.autodoc', 'sphinxcontrib.httpdomain', 'ext.support_matrix', 'ext.custom_css', - 'openstackdocstheme'] + 'openstackdocstheme', + 'oslo_config.sphinxconfiggen'] # openstackdocstheme options repository_name = 'openstack/designate' @@ -40,6 +41,9 @@ bug_project = 'designate' bug_tag = '' html_last_updated_fmt = '%Y-%m-%d %H:%M' +config_generator_config_file = '../../etc/designate/designate-config-generator.conf' +sample_config_basename = '_static/designate' + # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] diff --git a/doc/source/configuration/index.rst b/doc/source/configuration/index.rst new file mode 100644 index 000000000..074618a6c --- /dev/null +++ b/doc/source/configuration/index.rst @@ -0,0 +1,47 @@ +.. + Copyright 2011 OpenStack Foundation + All Rights Reserved. + + 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: + +Designate Configuration Guide +============================= + +Designate configuration is needed for getting it work correctly +either with real OpenStack environment or without OpenStack environment. + +**NOTE:** The most of the following operations should performed in designate +directory. + +.. index:: + double: configure; designate + +#. Create the designate.conf file + + :: + + $ editor designate.conf + +#. Copy or mirror the configuration from this sample file here: + + .. literalinclude:: ../examples/basic-config-sample.conf + :language: ini + +#. You can generate full sample *designate.conf* (if it does not already exist):: + + $ oslo-config-generator --config-file etc/designate/designate-config-generator.conf --output-file /etc/designate/designate.conf + +.. literalinclude:: ../_static/designate.conf.sample + :language: ini diff --git a/doc/source/contributor/ubuntu-dev.rst b/doc/source/contributor/ubuntu-dev.rst index fdd941a2b..835e86a28 100644 --- a/doc/source/contributor/ubuntu-dev.rst +++ b/doc/source/contributor/ubuntu-dev.rst @@ -116,20 +116,7 @@ Installing Designate Configuring Designate ====================== -.. index:: - double: configure; designate - -Create the designate.conf file - -:: - - $ editor designate.conf - - -Copy or mirror the configuration from this sample file here: - -.. literalinclude:: ../examples/basic-config-sample.conf - :language: ini +Refer to :ref:`configuration` for a sample configuration options. Installing RabbitMQ diff --git a/doc/source/index.rst b/doc/source/index.rst index b53e5b2a4..007500ac4 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -22,6 +22,7 @@ Contents contributor/index user/index admin/index + configuration/index This documentation is generated by the Sphinx toolkit and lives in the `source tree `_.