===========================================
Designate, a DNSaaS component for OpenStack
===========================================

Designate is a multi-tenant DNSaaS service for OpenStack. It provides a REST
API with integrated Keystone authentication. It can be configured to
auto-generate records based on Nova and Neutron actions. Designate supports
a variety of DNS servers including Bind9 and PowerDNS.

.. toctree::
    :maxdepth: 1

    Install Guide <https://docs.openstack.org/project-install-guide/dns/ocata/>
    API Reference <https://developer.openstack.org/api-ref/dns/>
    Openstack CLI <https://docs.openstack.org/developer/python-designateclient/shell-v2.html>
    getting-involved
    devstack
    support-matrix
    backends
    tempest <https://docs.openstack.org/developer/designate-tempest-plugin>

This documentation is generated by the Sphinx toolkit and lives in the `source tree`_.

Developer Documentation
=======================

.. toctree::
    :maxdepth: 1

    architecture
    integrations
    ubuntu-dev
    gmr
    sourcedoc
    metrics

User Guide
==========

.. toctree::
    :maxdepth: 1

    howtos/manage-ptr-records
    howtos/secondary-zones
    rest

Administration Guide
====================

.. toctree::
    :maxdepth: 1

    pools
    pool-scheduler
    troubleshooting
    howtos/multiple-pools
    howtos/blacklists
    howtos/tlds
    howtos/quotas
    designate-manage
    notifications
    production-guidelines

Upgrades
========

.. toctree::
    :maxdepth: 1

    upgrade/kilo
    upgrade/mitaka
    upgrade/newton
    upgrade/ocata

Other Modules
=============

.. toctree::
    :maxdepth: 1

    python-designateclient <https://docs.openstack.org/developer/python-designateclient/>
    designate-dashboard <https://docs.openstack.org/developer/designate-dashboard/>
    designate-tempest-plugin <https://docs.openstack.org/developer/designate-tempest-plugin/>
    designate-specs <https://docs.openstack.org/developer/designate-specs/>
    designate-msdnsagent <https://docs.openstack.org/developer/designate-msdnsagent/>

Other Resources
===============

.. toctree::
    :maxdepth: 1

    related

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

.. _source tree: https://git.openstack.org/cgit/openstack/designate
