OpenStack DNS As A Service (Designate). Mirror of code maintained at opendev.org.
========================
.. image:: https://governance.openstack.org/tc/badges/designate.svg :target: https://governance.openstack.org/tc/reference/tags/index.html
.. Change things from this point on
===================
Designate is an OpenStack project, providing DNSaaS.
IRC: #openstack-dns @ freenode
Installation: https://docs.openstack.org/designate/latest/
To learn how to use Designate's API, consult the documentation available online at:
DNS API Reference__
For more information on OpenStack APIs, SDKs and CLIs in general, refer to:
OpenStack for App Developers__
Development resources for OpenStack clouds__
Designate follows the
OpenStack Gerrit Workflow_
Setup a working environment:
.. code-block:: bash
git clone https://opendev.org/openstack/designate cd designate virtualenv .venv . .venv/bin/activate pip install -r requirements.txt -r test-requirements.txt pip install -e .
To build the documentation from the restructured text source, do the following:
.. code-block:: bash
tox -e docs
Now point your browser at doc/build/html/index.html (the official documentation is published to
docs.openstack.org_ by the maintainers.
Execute all unit tests
.. code-block:: shell
tox -e py36
Execute only backend tests
.. code-block:: shell
tox -e py36 -- unit.backend
Execute only a single test
.. code-block:: shell
tox -e py36 -- unit.backend.test_pdns4.PDNS4BackendTestCase.test_create_zone_success
Install the git-review package to make life easier
.. code-block:: shell
pip install git-review
Branch, work, & submit:
.. code-block:: shell
# cut a new branch, tracking master git checkout --track -b bug/id origin/master # work work work git add stuff git commit # rebase/squash to a single commit before submitting git rebase -i # submit git-review
.. _OpenStack Gerrit Workflow: https://docs.openstack.org/infra/manual/developers.html#development-workflow .. _docs.openstack.org: https://docs.openstack.org/designate/latest/