designate/doc/source/configuration/index.rst
Hieu LE 3f1fe07d06 doc: Populate the 'configuration' section
Per the spec [1]:
    configuration/ – automatically generated configuration reference
    information based on oslo.config’s sphinx integration (or manually
    written for projects not using oslo.config). Step-by-step guides for
    doing things like enabling cells or configuring a specific driver
    should be placed in the admin/ section.

Only the sample_config file fit into this category at present.
Let's add new sample_config file and move the configuration section to
this category.

Change-Id: I789fe53f4df9409dd6e4a6d5f9280feb65792258
Implements: blueprint designate-doc-migration
Partial-Bug: #1706173
2017-07-25 08:36:01 +07:00

1.5 KiB

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.

double: configure; designate

  1. Create the designate.conf file

    $ editor designate.conf
  2. Copy or mirror the configuration from this sample file here:

    ../examples/basic-config-sample.conf

  3. 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

../_static/designate.conf.sample