designate/doc/source/index.rst

107 lines
1.9 KiB
ReStructuredText

===========================================
Designate, a DNSaaS component for OpenStack
===========================================
Designate provides DNSaaS services for OpenStack:
* REST API for domain & record management
* Multi-tenant support
* Integrated with Keystone for authentication
* Framework in place to integrate with Nova and Neutron notifications (for auto-generated records)
* Support for PowerDNS and Bind9 out of the box
This document describes Designate for users, operation teams and contributors of the project.
This documentation is generated by the Sphinx toolkit and lives in the `source tree`_. Additional documentation on Designate may
also be found on the `OpenStack wiki`_.
General documentation
=====================
New to Designate? Start here:
.. toctree::
:maxdepth: 1
architecture
production-architecture
glossary
User documentation
==================
.. toctree::
:maxdepth: 1
:glob:
howtos/*
rest
Operations documentation
========================
Install Guides
--------------
.. toctree::
:maxdepth: 1
install/ubuntu-kilo
install/ubuntu-liberty
Upgrade Guides
--------------
.. toctree::
:maxdepth: 1
upgrade/kilo
upgrade/mitaka
Designate in general
--------------------
.. toctree::
:maxdepth: 1
ops/operations-faq
backends
configuration
designate-manage
gmr
integrations
memory-caching
pools
production-guidelines
service_status
notifications
support-matrix
Developer Documentation
=======================
.. toctree::
:maxdepth: 1
getting-involved
developer-guidelines
sourcedoc
install/ubuntu-dev
devstack
functional-tests
tempest
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
.. _OpenStack Wiki: https://wiki.openstack.org/wiki/Designate
.. _source tree: https://git.openstack.org/cgit/openstack/designate